nystudio107 / craft-retour

src/helpers/UrlHelper.php

<?php
/**
 * Retour plugin for Craft CMS
 *
 * 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;
use craft\errors\SiteNotFoundException;
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), SORT_REGULAR);

        return http_build_query($queryParams);
    }

    /**
     * Strip out any site-defined sub-path from the incoming $path
     * e.g. if the Site's baseUrl is set to https://example.com/es and $path is /es/blog
     * this function will return /blog
     *
     * @param string $path

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 stripSitePathPrefix(string $path): string
    {
        try {
            $baseSiteUrl = self::baseSiteUrl();
        } catch (SiteNotFoundException $e) {
            $baseSiteUrl = '';
        }
        $sitePath = parse_url($baseSiteUrl, PHP_URL_PATH);
        $addSlash = str_ends_with($path, '/');
        if (!empty($sitePath)) {
            // Normalizes a URI path by trimming leading/ trailing slashes and removing double slashes
            $sitePath = '/' . preg_replace('/\/\/+/', '/', trim($sitePath, '/'));
        }
        // Strip the $sitePath from the incoming $path
        if (str_starts_with($path, $sitePath)) {
            $path = substr($path, strlen($sitePath));
            $path = '/' . preg_replace('/\/\/+/', '/', trim($path, '/'));
        }
        $path = $addSlash ? $path . '/' : $path;

        return $path;
    }

    /**
     * See if the path includes a site prefix for any site
     *
     * @param string $path

Missing parameter comment

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

     * @return bool

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

     */
    public static function pathHasSitePrefix(string $path): bool
    {
        $sites = Craft::$app->getSites()->getAllSites();
        foreach ($sites as $site) {
            $sitePath = parse_url($site->baseUrl, PHP_URL_PATH);
            if (!empty($sitePath)) {
                // Normalizes a URI path by trimming leading/ trailing slashes and removing double slashes
                $sitePath = '/' . preg_replace('/\/\/+/', '/', trim($sitePath, '/'));
            }
            // See if the path begins with a site path prefix
            if ($sitePath !== '/' && str_starts_with($path, $sitePath)) {
                return true;
            }
        }

        return false;
    }

    /**
     * Merge the $url and $path together, combining any overlapping path segments
     *
     * @param ?string $url

Missing parameter comment

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

     * @param ?string $path

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 mergeUrlWithPath(?string $url, ?string $path): string
    {
        $overlap = 0;
        $url = $url ?? '';
        $path = $path ?? '';
        $url = rtrim($url, '/') . '/';
        $path = '/' . ltrim($path, '/');
        $urlOffset = strlen($url);
        $pathLength = strlen($path);
        $pathOffset = 0;
        while ($urlOffset > 0 && $pathOffset < $pathLength) {
            $urlOffset--;
            $pathOffset++;
            if (str_starts_with($path, substr($url, $urlOffset, $pathOffset))) {
                $overlap = $pathOffset;
            }
        }

        return rtrim($url, '/') . '/' . ltrim(substr($path, $overlap), '/');
    }

    /**
     * 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;
    }
}