nystudio107 / craft-retour

src/gql/interfaces/RetourInterface.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\interfaces;

use craft\gql\base\InterfaceType as BaseInterfaceType;

use craft\gql\GqlEntityRegistry;
use GraphQL\Type\Definition\InterfaceType;

use GraphQL\Type\Definition\Type;
use nystudio107\retour\gql\types\generators\RetourGenerator;

/**
 * Class RetourInterface
 *
 * @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 RetourInterface extends BaseInterfaceType
{
    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public static function getTypeGenerator(): string
    {
        return RetourGenerator::class;
    }

    /**

Missing short description in doc comment

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

     * @inheritdoc
     */

Missing @return tag in function comment

    public static function getType($fields = null): Type

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

    {
        if ($type = GqlEntityRegistry::getEntity(self::class)) {
            return $type;
        }

        $type = GqlEntityRegistry::createEntity(self::class, new InterfaceType([

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

            'name' => static::getName(),
            'fields' => self::class . '::getFieldDefinitions',
            'description' => 'This is the interface implemented by Retour.',
            'resolveType' => function(array $value) {

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

Expected 1 space after FUNCTION keyword; 0 found

                return GqlEntityRegistry::getEntity(RetourGenerator::getName());
            },
        ]));

For multi-line function calls, the closing parenthesis should be on a new line.

        RetourGenerator::generateTypes();

        return $type;
    }

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public static function getName(): string
    {
        return 'RetourInterface';
    }

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public static function getFieldDefinitions(): array
    {
        return array_merge(parent::getFieldDefinitions(), [

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

            'id' => [
                'name' => 'id',
                'type' => Type::int(),
                'description' => 'The id of the redirect.',
            ],
            'site' => [
                'name' => 'site',
                'type' => Type::string(),
                'description' => 'The site handle of the redirect (or null for all sites).',
            ],
            'siteId' => [
                'name' => 'siteId',
                'type' => Type::int(),
                'description' => 'The siteId of the redirect (0 or null for all sites).',
            ],
            'associatedElementId' => [
                'name' => 'associatedElementId',
                'type' => Type::int(),
                'description' => 'The id of the Element associated with this redirect (unused/vestigial).',
            ],
            'enabled' => [
                'name' => 'enabled',
                'type' => Type::boolean(),
                'description' => 'Whether the redirect is enabled or not.',
            ],
            'redirectSrcUrl' => [
                'name' => 'redirectSrcUrl',
                'type' => Type::string(),
                'description' => 'The unparsed URL pattern that Retour should match.',
            ],
            'redirectSrcUrlParsed' => [
                'name' => 'redirectSrcUrlParsed',
                'type' => Type::string(),
                'description' => 'The parsed URL pattern that Retour should match.',
            ],
            'redirectSrcMatch' => [
                'name' => 'redirectSrcMatch',
                'type' => Type::string(),
                'description' => 'Should the legacy URL be matched by path or by full URL?',
            ],
            'redirectMatchType' => [
                'name' => 'redirectMatchType',
                'type' => Type::string(),
                'description' => 'Whether an `exactmatch` or `regexmatch` should be used when matching the URL.',
            ],
            'redirectDestUrl' => [
                'name' => 'redirectDestUrl',
                'type' => Type::string(),
                'description' => 'The URL that should be redirected to.',
            ],
            'redirectHttpCode' => [
                'name' => 'redirectHttpCode',
                'type' => Type::int(),
                'description' => 'The http status code that should be used for the redirect.',
            ],
            'hitCount' => [
                'name' => 'hitCount',
                'type' => Type::int(),
                'description' => 'The number of times this redirect has been hit.',
            ],
            'hitLastTime' => [
                'name' => 'hitLastTime',
                'type' => Type::string(),
                'description' => 'A datetime string of when this redirect was last hit.',
            ],
        ]);

For multi-line function calls, the closing parenthesis should be on a new line.

    }
}