nystudio107\similar\services\ServicesTrait

Complexity

Total Complexity

2

Size/Duplication

Total Lines	29
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	config()	0	5	1
A	getSimilar()	0	3	1

<?php
/**
 * Similar plugin for Craft CMS 3.x
 *
 * Similar for Craft lets you find elements, Entries, Categories, Commerce
 * Products, etc, that are similar, based on... other related elements.
 *
 * @link      https://nystudio107.com/

The tag in position 1 should be the @copyright tag

 * @copyright Copyright (c) 2018 nystudio107.com

@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\similar\services;

use nystudio107\similar\services\Similar as SimilarService;
use yii\base\InvalidConfigException;

/**

Missing short description in doc comment

 * @author    nystudio107.com

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   Similar

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

 * @since     1.0.0

The tag in position 3 should be the @author tag

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

 *
 * @property  SimilarService $similar

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' => [
                'similar' => SimilarService::class,
            ],
        ];
    }

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

    /**
     * Returns the similar service
     *
     * @return SimilarService The similar service
     * @throws InvalidConfigException
     */
    public function getSimilar(): SimilarService
    {
        return $this->get('similar');

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

    }
}