nystudio107 / craft-transcoder

src/variables/TranscoderVariable.php

<?php
/**
 * Transcoder plugin for Craft CMS
 *
 * Transcode videos to various formats, and provide thumbnails of the video
 *
 * @link      https://nystudio107.com

The tag in position 1 should be the @copyright tag

 * @copyright Copyright (c) 2017 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\transcoder\variables;

use craft\helpers\UrlHelper;
use nystudio107\pluginvite\variables\ViteVariableInterface;
use nystudio107\pluginvite\variables\ViteVariableTrait;
use nystudio107\transcoder\Transcoder;
use yii\base\InvalidConfigException;

/**

Missing short description in doc comment

 * @author    nystudio107

Tag value for @author tag indented incorrectly; expected 2 spaces but found 4

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>"

 * @package   Transcode

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 @link tag in class comment

Missing @license tag in class comment

Missing @category tag in class comment

class TranscoderVariable implements ViteVariableInterface
{
    use ViteVariableTrait;

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

    /**
     * Returns a URL to the transcoded video or "" if it doesn't exist (at which
     * time it will create it).
     *
     * @param $filePath

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @param $videoOptions

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @param bool $generate

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return string

Tag @return cannot be grouped with parameter tags in a doc comment

     * @throws InvalidConfigException

Tag @throws cannot be grouped with parameter tags in a doc comment

     * @bool $generate

Tag @bool cannot be grouped with parameter tags in a doc comment

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

     *
     */

Additional blank lines found at end of doc comment

    public function getVideoUrl($filePath, $videoOptions, bool $generate = true): string
    {
        return Transcoder::$plugin->transcode->getVideoUrl($filePath, $videoOptions, $generate);
    }

    /**
     * Returns a URL to a video thumbnail
     *
     * @param $filePath

Missing parameter comment

     * @param $thumbnailOptions

Missing parameter comment

     *
     * @return string|false|null URL or path of the video thumbnail
     * @throws InvalidConfigException
     */
    public function getVideoThumbnailUrl($filePath, $thumbnailOptions): string|false|null
    {
        return Transcoder::$plugin->transcode->getVideoThumbnailUrl($filePath, $thumbnailOptions);
    }

    /**
     * Returns a URL to the transcoded audio file or "" if it doesn't exist
     * (at which time it will create it).
     *
     * @param $filePath

Missing parameter comment

     * @param $audioOptions

Missing parameter comment

     *
     * @return string
     * @throws InvalidConfigException
     */
    public function getAudioUrl($filePath, $audioOptions): string
    {
        return Transcoder::$plugin->transcode->getAudioUrl($filePath, $audioOptions);
    }

    /**
     * Extract information from a video/audio file
     *
     * @param      $filePath

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 1 spaces but found 6

     * @param bool $summary

Missing parameter comment

     *
     * @return ?array
     * @throws InvalidConfigException
     */
    public function getFileInfo($filePath, bool $summary = false): ?array
    {
        return Transcoder::$plugin->transcode->getFileInfo($filePath, $summary);
    }

    /**
     * Get a video progress URL
     *
     * @param $filePath

Missing parameter comment

     * @param $videoOptions

Missing parameter comment

     *
     * @return string
     * @throws InvalidConfigException
     */
    public function getVideoProgressUrl($filePath, $videoOptions): string
    {
        $result = '';
        $filename = Transcoder::$plugin->transcode->getVideoFilename($filePath, $videoOptions);
        if (!empty($filename)) {
            $urlParams = [
                'filename' => $filename,
            ];
            $result = UrlHelper::actionUrl('transcoder/default/progress', $urlParams);
        }

        return $result;
    }

    /**
     * Get an audio progress URL
     *
     * @param $filePath

Missing parameter comment

     * @param $audioOptions

Missing parameter comment

     *
     * @return string
     * @throws InvalidConfigException
     */
    public function getAudioProgressUrl($filePath, $audioOptions): string
    {
        $result = '';
        $filename = Transcoder::$plugin->transcode->getAudioFilename($filePath, $audioOptions);
        if (!empty($filename)) {
            $urlParams = [
                'filename' => $filename,
            ];
            $result = UrlHelper::actionUrl('transcoder/default/progress', $urlParams);
        }

        return $result;
    }

    /**
     * Get a GIF progress URL
     *
     * @param $filePath

Missing parameter comment

     * @param $gifOptions

Missing parameter comment

     *
     * @return string
     * @throws InvalidConfigException
     */
    public function getGifProgressUrl($filePath, $gifOptions): string
    {
        $result = '';
        $filename = Transcoder::$plugin->transcode->getGifFilename($filePath, $gifOptions);
        if (!empty($filename)) {
            $urlParams = [
                'filename' => $filename,
            ];
            $result = UrlHelper::actionUrl('transcoder/default/progress', $urlParams);
        }

        return $result;
    }

    /**
     * Get a download URL
     *
     * @param $url

Missing parameter comment

     *
     * @return string
     */
    public function getDownloadUrl($url): string
    {
        $result = '';
        $filePath = parse_url($url, PHP_URL_PATH);
        $filePath = $_SERVER['DOCUMENT_ROOT'] . $filePath;
        if (file_exists($filePath)) {
            $urlParams = [
                'url' => $url,
            ];
            $result = UrlHelper::actionUrl('transcoder/default/download-file', $urlParams);
        }

        return $result;
    }

    /**
     * Returns a URL to a GIF file
     *
     * @param $filePath

Missing parameter comment

     * @param $gifOptions

Missing parameter comment

     *
     * @return string|false|null
     * @throws InvalidConfigException
     */
    public function getGifUrl($filePath, $gifOptions): string|false|null
    {
        return Transcoder::$plugin->transcode->getGifUrl($filePath, $gifOptions);
    }
}