nystudio107\vite\services\ServicesTrait

Complexity

Total Complexity

3

Size/Duplication

Total Lines	41
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	1

3 Methods

Rating	Name	Duplication	Size	Complexity
A	config()	0	6	1
A	getVite()	0	3	1
A	getHelper()	0	3	1

<?php
/**
 * Vite plugin for Craft CMS
 *
 * Allows the use of the Vite.js next generation frontend tooling with Craft CMS
 *
 * @link      https://nystudio107.com

The tag in position 1 should be the @copyright tag

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

use nystudio107\pluginvite\services\ViteService;
use nystudio107\vite\helpers\PluginConfig as PluginConfigHelper;
use nystudio107\vite\services\Helper as HelperService;
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   Vite

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

 * @since     4.0.4

The tag in position 3 should be the @author tag

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

 *
 * @property  ViteService $vite

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

 * @property  HelperService $helper

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

 */

Missing @category tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

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

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public static function config(): array
    {
        return [
            'components' => [
                'helper' => HelperService::class,
                'vite' => PluginConfigHelper::serviceDefinitionFromConfig('vite', ViteService::class),
            ],
        ];
    }

    // Public Methods
    // =========================================================================

    /**
     * Returns the helper service
     *
     * @return HelperService The helper service
     * @throws InvalidConfigException
     */
    public function getHelper(): HelperService
    {
        return $this->get('helper');

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

    }

    /**
     * Returns the vite service
     *
     * @return ViteService The helper service
     * @throws InvalidConfigException
     */
    public function getVite(): ViteService
    {
        return $this->get('vite');
    }
}