nystudio107 / craft-retour

src/gql/queries/RetourQuery.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\queries;

use craft\gql\base\Query;
use GraphQL\Type\Definition\Type;
use nystudio107\retour\gql\arguments\RetourArguments;

use nystudio107\retour\gql\interfaces\RetourInterface;
use nystudio107\retour\gql\resolvers\RetourResolver;
use nystudio107\retour\helpers\Gql as GqlHelper;

/**
 * Class RetourQuery
 *
 * @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

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

The tag in position 3 should be the @author tag

 */

Missing @category tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

class RetourQuery extends Query
{
    /**

Missing short description in doc comment

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

     * @inheritdoc
     */

Missing @return tag in function comment

    public static function getQueries($checkToken = true): array
    {
        if ($checkToken && !GqlHelper::canQueryRetour()) {
            return [];
        }

        return [
            'retour' => [
                'type' => RetourInterface::getType(),
                'args' => RetourArguments::getArguments(),
                'resolve' => RetourResolver::class . '::resolve',
                'description' => 'This query is used to query for Retour redirects.',
                'deprecationReason' => 'This query is deprecated and will be removed in the future. You should use `retourResolveRedirect` instead.',
            ],
            'retourResolveRedirect' => [
                'type' => RetourInterface::getType(),
                'args' => RetourArguments::getArguments(),
                'resolve' => RetourResolver::class . '::resolve',
                'description' => 'This query is used to query for Retour redirects.',
            ],
            'retourRedirects' => [
                'type' => Type::listOf(RetourInterface::getType()),
                'args' => [
                    'site' => [
                        'name' => 'site',
                        'type' => Type::string(),
                        'description' => 'The site handle to list all redirects for.',
                    ],
                    'siteId' => [
                        'name' => 'siteId',
                        'type' => Type::int(),
                        'description' => 'The siteId to list all redirects for.',
                    ],
                ],
                'resolve' => RetourResolver::class . '::resolveAll',
                'description' => 'This query is used to query for all Retour redirects for a site.',
            ],
        ];
    }
}