nystudio107 / craft-youtubeliveembed

src/YoutubeLiveEmbed.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) 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\youtubeliveembed;

use Craft;
use craft\base\Plugin;
use craft\web\twig\variables\CraftVariable;
use nystudio107\youtubeliveembed\models\Settings;
use nystudio107\youtubeliveembed\services\ServicesTrait;
use nystudio107\youtubeliveembed\variables\YoutubeLiveEmbedVariable;
use yii\base\Event;

/**
 * Class YoutubeLiveEmbed
 *
 * @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.0

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 YoutubeLiveEmbed extends Plugin
{
    // Traits
    // =========================================================================

    use ServicesTrait;

    // Static Properties
    // =========================================================================

    /**

Missing short description in doc comment

     * @var YoutubeLiveEmbed
     */
    public static $plugin;

    /**

Missing short description in doc comment

     * @var string
     */
    public static $youtubeChannelId;

    // Public Properties
    // =========================================================================

    /**

Missing short description in doc comment

     * @var string
     */
    public $schemaVersion = '1.0.10';

    /**

Missing short description in doc comment

     * @var bool
     */
    public $hasCpSection = false;

    /**

Missing short description in doc comment

     * @var bool
     */
    public $hasCpSettings = true;

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

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public function init()
    {
        parent::init();
        self::$plugin = $this;
        /** @var Settings $settings */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

        $settings = $this->getSettings();
        self::$youtubeChannelId = $settings->youtubeChannelId;

        Event::on(
            CraftVariable::class,
            CraftVariable::EVENT_INIT,
            function(Event $event) {

Expected 1 space after FUNCTION keyword; 0 found

                /** @var CraftVariable $variable */

Missing short description in doc comment

The open comment tag must be the only content on the line

The close comment tag must be the only content on the line

                $variable = $event->sender;
                $variable->set('youtubelive', YoutubeLiveEmbedVariable::class);
            }
        );

        Craft::info(
            Craft::t(
                'youtubeliveembed',
                '{name} plugin loaded',
                ['name' => $this->name]
            ),
            __METHOD__
        );
    }

    // Protected Methods
    // =========================================================================

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    protected function createSettingsModel()
    {
        return new Settings();
    }

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    protected function settingsHtml(): string
    {
        return Craft::$app->view->renderTemplate(
            'youtubeliveembed/settings',
            [
                'settings' => $this->getSettings(),
            ]
        );
    }
}