nystudio107 / craft-retour

src/gql/resolvers/RetourResolver.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) 2019 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\gql\resolvers;

use Craft;
use craft\base\Element;
use craft\errors\SiteNotFoundException;
use craft\gql\base\Resolver;
use GraphQL\Type\Definition\ResolveInfo;
use nystudio107\retour\helpers\UrlHelper;
use nystudio107\retour\Retour;
use Throwable;

/**
 * Class RetourResolver
 *
 * @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.26

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 RetourResolver extends Resolver
{
    /**

Missing short description in doc comment

Parameter $source should have a doc-comment as per coding-style.

Parameter $arguments should have a doc-comment as per coding-style.

Parameter $context should have a doc-comment as per coding-style.

Parameter $resolveInfo should have a doc-comment as per coding-style.

     * @inheritDoc
     */

Missing @return tag in function comment

    public static function resolve(mixed $source, array $arguments, mixed $context, ResolveInfo $resolveInfo): mixed
    {
        // If our source is an Element, extract the URI and siteId from it
        if ($source instanceof Element) {
            /** Element $source */

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

Doc comment short description must be on the first line

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

            $uri = $source->uri;
            $siteId = $source->siteId;
        } else {
            // Otherwise, use the passed in arguments, or defaults
            $uri = $arguments['uri'] ?? '/';
            $siteId = $arguments['siteId'] ?? null;
            if (isset($arguments['site'])) {
                $site = Craft::$app->getSites()->getSiteByHandle($arguments['site']);
                if ($site !== null) {
                    $siteId = $site->id;
                }
            }
        }
        $uri = trim($uri === '/' ? '__home__' : $uri);

        $redirect = null;

        // Strip the query string if `alwaysStripQueryString` is set
        if (Retour::$settings->alwaysStripQueryString) {
            $uri = UrlHelper::stripQueryString($uri);
        }

        if (!Retour::$plugin->redirects->excludeUri($uri)) {

The method excludeUri() does not exist on null.

            $redirect = Retour::$plugin->redirects->findRedirectMatch($uri, $uri, $siteId);

            if ($redirect === null && Craft::$app->getElements()->getElementByUri(trim($uri, '/'), $siteId) === null) {
                // Set the `site` virtual field
                $redirect['site'] = null;
                $redirect['siteId'] = $siteId;
                if (isset($redirect['siteId']) && (int)$redirect['siteId'] !== 0) {
                    $site = Craft::$app->getSites()->getSiteById((int)$redirect['siteId']);
                    if ($site !== null) {
                        $redirect['site'] = $site->handle;
                    }
                }
                // Increment the stats
                Retour::$plugin->statistics->incrementStatistics($uri, false, $siteId);

The method incrementStatistics() does not exist on null.

            }
        }
        if ($redirect !== null && isset($redirect['redirectDestUrl'])) {
            $dest = $redirect['redirectDestUrl'];
            $path = $redirect['redirectDestUrl'];
            // Combine the URL and path together, merging them as appropriate
            try {
                if (!UrlHelper::isAbsoluteUrl($dest) && !UrlHelper::pathHasSitePrefix($path)) {
                    $dest = UrlHelper::siteUrl('/', null, null, $siteId);
                    $dest = UrlHelper::mergeUrlWithPath($dest, $path);
                    $dest = parse_url($dest, PHP_URL_PATH);
                }
            } catch (Throwable $e) {
                // That's ok
            }
            $redirect['redirectDestUrl'] = $dest;
        }

        return $redirect;
    }

    /**
     * Return all static redirects for a site.
     *
     * @param $source

Missing parameter comment

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

     * @param array $arguments

Missing parameter comment

Expected 7 spaces after parameter type; 1 found

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

     * @param $context

Missing parameter comment

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

     * @param ResolveInfo $resolveInfo

Missing parameter comment

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

     * @return array

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

     * @throws SiteNotFoundException

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

     */
    public static function resolveAll($source, array $arguments, $context, ResolveInfo $resolveInfo)

The parameter $source is not used and could be removed.

The parameter $resolveInfo is not used and could be removed.

The parameter $context is not used and could be removed.

    {
        $siteId = $arguments['siteId'] ?? Craft::$app->getSites()->getCurrentSite()->id;

        $redirects = Retour::$plugin->redirects->getAllStaticRedirects(null, $siteId);

        return $redirects;
    }
}