nystudio107 / craft-youtubeliveembed

src/variables/YoutubeLiveEmbedVariable.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\variables;

use nystudio107\youtubeliveembed\YoutubeLiveEmbed;
use Twig\Markup;

/**

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.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 YoutubeLiveEmbedVariable
{
    // Public Methods
    // =========================================================================

    /**
     * Renders the responsive iframe for the live stream video
     *
     * @param int $aspectRatioX

Missing parameter comment

     * @param int $aspectRatioY

Missing parameter comment

     *
     * @return Markup
     */
    public function embedStream(int $aspectRatioX = 16, int $aspectRatioY = 9): Markup
    {
        return YoutubeLiveEmbed::$plugin->embed->embedStream($aspectRatioX, $aspectRatioY);
    }

    /**
     * Renders the responsive Google AMP iframe for the live stream video
     *
     * @param int $aspectRatioX

Missing parameter comment

     * @param int $aspectRatioY

Missing parameter comment

     *
     * @return Markup
     */
    public function embedStreamAmp(int $aspectRatioX = 16, int $aspectRatioY = 9): Markup
    {
        return YoutubeLiveEmbed::$plugin->embed->embedStreamAmp($aspectRatioX, $aspectRatioY);
    }

    /**
     * Renders the responsive iframe HTML for the live stream chat
     *
     * @param int $aspectRatioX

Missing parameter comment

     * @param int $aspectRatioY

Missing parameter comment

     *
     * @return Markup
     */
    public function embedChat(int $aspectRatioX = 16, int $aspectRatioY = 9): Markup
    {
        return YoutubeLiveEmbed::$plugin->embed->embedChat($aspectRatioX, $aspectRatioY);
    }

    /**
     * Renders the responsive Google AMP iframe HTML for the live stream chat
     *
     * @param int $aspectRatioX

Missing parameter comment

     * @param int $aspectRatioY

Missing parameter comment

     *
     * @return Markup
     */
    public function embedChatAmp(int $aspectRatioX = 16, int $aspectRatioY = 9): Markup
    {
        return YoutubeLiveEmbed::$plugin->embed->embedChatAmp($aspectRatioX, $aspectRatioY);
    }

    /**
     * Sets the YouTube Channel ID to $channelId
     *
     * @param string $channelId

Missing parameter comment

     *
     * @return string
     */
    public function setChannelId(string $channelId): string
    {
        YoutubeLiveEmbed::$plugin->embed->setChannelId($channelId);

        return '';
    }

    /**
     * Returns whether the stream is currently live
     *
     * @return bool
     */
    public function isLive(): bool
    {
        return YoutubeLiveEmbed::$plugin->embed->isLive();
    }
}