nystudio107 / craft-youtubeliveembed

src/services/ServicesTrait.php

<?php
/**
 * YouTube Live Embed plugin for Craft CMS
 *
 * This plugin allows you to embed a YouTube live stream and/or live chat on your webpage
 *
 * @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\youtubeliveembed\services;

use craft\helpers\ArrayHelper;
use nystudio107\youtubeliveembed\services\Embed as EmbedService;
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   YoutubeLiveEmbed

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

 * @since     1.0.6

The tag in position 3 should be the @author tag

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

 *
 * @property  EmbedService $embed

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 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' => [
                'embed' => EmbedService::class,
            ]
        ], $config);

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

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

    /**
     * Returns the embed service
     *
     * @return EmbedService The embed service
     * @throws InvalidConfigException
     */
    public function getEmbed(): EmbedService
    {
        return $this->get('embed');

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

    }
}