nystudio107\routemap\services\ServicesTrait

Complexity

Total Complexity

2

Size/Duplication

Total Lines	30
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	getRoutes()	0	3	1
A	__construct()	0	11	1

<?php
/**
 * Route Map plugin for Craft CMS 3.x
 *
 * Returns a list of public routes for elements with URLs
 *
 * @link      https://nystudio107.com/

The tag in position 1 should be the @copyright tag

 * @copyright Copyright (c) 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\routemap\services;

use craft\helpers\ArrayHelper;
use nystudio107\routemap\services\Routes as RoutesService;
use yii\base\InvalidConfigException;

/**

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   RouteMap

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

 * @since     1.1.9

The tag in position 3 should be the @author tag

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

 *
 * @property RoutesService $routes
 */

Missing @category tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

trait ServicesTrait
{
    // Public Methods
    // =========================================================================

    /**

Missing short description in doc comment

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

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

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

     * @inheritdoc
     */
    public function __construct($id, $parent = null, array $config = [])
    {
        // Merge in the passed config, so it our config can be overridden by Plugins::pluginConfigs['vite']
        // ref: https://github.com/craftcms/cms/issues/1989
        $config = ArrayHelper::merge([

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

            'components' => [
                'routes' => RoutesService::class,
            ],
        ], $config);

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

        parent::__construct($id, $parent, $config);
    }

    /**
     * Returns the routes service
     *
     * @return RoutesService The routes service
     * @throws InvalidConfigException
     */
    public function getRoutes(): RoutesService
    {
        return $this->get('routes');

It seems like get() must be provided by classes using this trait. How about adding it as abstract method to this trait?

    }
}