nystudio107 / craft-youtubeliveembed

src/services/Embed.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\services;

use Craft;
use craft\base\Component;
use craft\helpers\UrlHelper;
use nystudio107\youtubeliveembed\helpers\PluginTemplate;
use nystudio107\youtubeliveembed\models\Settings;
use nystudio107\youtubeliveembed\YoutubeLiveEmbed;
use Twig\Markup;

/** @noinspection MissingPropertyAnnotationsInspection */

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

/**

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 Embed extends Component
{
    // Constants
    // =========================================================================

    const YOUTUBE_STREAM_URL = 'https://www.youtube.com/embed/live_stream';
    const YOUTUBE_CHAT_URL = 'https://www.youtube.com/live_chat';

    // 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
    {
        $html = PluginTemplate::renderPluginTemplate(
            'embeds/youtube-live-stream.twig',
            [
                'aspectRatio' => ($aspectRatioY / $aspectRatioX) * 100,
                'iframeUrl' => $this->getYoutubeStreamUrl(),
            ]
        );

        return $html;
    }

    /**
     * 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
    {
        $html = PluginTemplate::renderPluginTemplate(
            'embeds/youtube-live-stream-amp.twig',
            [
                'aspectRatio' => ($aspectRatioY / $aspectRatioX) * 100,
                'iframeUrl' => $this->getYoutubeStreamUrl(),
            ]
        );

        return $html;
    }

    /**
     * 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
    {
        $html = PluginTemplate::renderPluginTemplate(
            'embeds/youtube-live-chat.twig',
            [
                'aspectRatio' => ($aspectRatioY / $aspectRatioX) * 100,
                'iframeUrl' => $this->getYoutubeChatUrl(),
                'embedDomain' => $this->getSiteDomain(),
            ]
        );

        return $html;
    }

    /**
     * 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
    {
        $html = PluginTemplate::renderPluginTemplate(
            'embeds/youtube-live-chat-amp.twig',
            [
                'aspectRatio' => ($aspectRatioY / $aspectRatioX) * 100,
                'iframeUrl' => $this->getYoutubeChatUrl(),
                'embedDomain' => $this->getSiteDomain(),
            ]
        );

        return $html;
    }

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

Missing parameter comment

     */

Missing @return tag in function comment

    public function setChannelId(string $channelId)
    {
        YoutubeLiveEmbed::$youtubeChannelId = $channelId;
    }

    /**
     * Returns whether the stream is currently live
     *
     * @return bool
     */
    public function isLive(): bool
    {
        /** @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 = YoutubeLiveEmbed::$plugin->getSettings();
        return $settings->isLive;
    }

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

    /**
     * Returns the URL to the live video YouTube page
     *
     * @return string
     */
    protected function getYoutubeStreamUrl(): string
    {
        $url = UrlHelper::urlWithParams(self::YOUTUBE_STREAM_URL, [

The opening parenthesis of a multi-line function call should be the last content on the line.

            'channel' => YoutubeLiveEmbed::$youtubeChannelId,
        ]);

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

        return $url;
    }

    /**
     * Returns the URL to the live chat YouTube page
     *
     * @return string
     */
    protected function getYoutubeChatUrl(): string
    {
        $url = '';
        $videoId = $this->getVideoIdFromLiveStream();
        if ($videoId) {
            $url = UrlHelper::urlWithParams(self::YOUTUBE_CHAT_URL, [

The opening parenthesis of a multi-line function call should be the last content on the line.

                'v' => $this->getVideoIdFromLiveStream(),
                'embed_domain' => $this->getSiteDomain(),
            ]);

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

        }

        return $url;
    }


    /**
     * Returns the domain of the host site
     *
     * @return string
     */
    protected function getSiteDomain()
    {
        $site = Craft::$app->getSites()->currentSite;
        $request = Craft::$app->getRequest();
        $domain = parse_url($site->getBaseUrl(), PHP_URL_HOST);
        return $domain ?? $request->getHostName();
    }

    /**
     * Extracts the Video ID of the current live stream video
     *
     * @return null|string
     */
    protected function getVideoIdFromLiveStream()
    {
        $videoId = null;
        $liveUrl = $this->getYoutubeStreamUrl();
        // Fetch the livestream page
        if ($data = @file_get_contents($liveUrl)) {
            // Find the video ID in there
            if (preg_match('/\"VIDEO_ID\":\"(.*?)\"/', $data, $matches)) {
                $videoId = $matches[1];
            }
        }

        return $videoId;
    }
}