nystudio107 / craft-transcoder

src/Transcoder.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;

use Craft;
use craft\base\Plugin;
use craft\console\Application as ConsoleApplication;
use craft\elements\Asset;
use craft\events\AssetThumbEvent;
use craft\events\PluginEvent;
use craft\events\RegisterCacheOptionsEvent;
use craft\events\RegisterUrlRulesEvent;
use craft\helpers\Assets as AssetsHelper;
use craft\helpers\FileHelper;
use craft\helpers\UrlHelper;
use craft\services\Assets;
use craft\services\Plugins;
use craft\utilities\ClearCaches;
use craft\web\twig\variables\CraftVariable;
use craft\web\UrlManager;
use nystudio107\transcoder\models\Settings;
use nystudio107\transcoder\services\ServicesTrait;
use nystudio107\transcoder\variables\TranscoderVariable;
use yii\base\ErrorException;
use yii\base\Event;

/**
 * Class Transcode
 *
 * @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   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 @category tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

class Transcoder extends Plugin
{
    // Traits
    // =========================================================================

    use ServicesTrait;

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

    /**

Missing short description in doc comment

     * @var Transcoder
     */
    public static $plugin;

    /**

Missing short description in doc comment

     * @var Settings
     */
    public static $settings;

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

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

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

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

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public function init()
    {
        parent::init();
        self::$plugin = $this;
        // Initialize properties
        self::$settings = self::$plugin->getSettings();
        // Handle console commands
        if (Craft::$app instanceof ConsoleApplication) {
            $this->controllerNamespace = 'nystudio107\transcoder\console\controllers';
        }
        // Add in our Craft components
        $this->addComponents();
        // Install our global event handlers
        $this->installEventHandlers();
        // We've loaded!
        Craft::info(
            Craft::t(
                'transcoder',
                '{name} plugin loaded',
                ['name' => $this->name]
            ),
            __METHOD__
        );
    }

    /**
     * Clear all the caches!
     */

Missing @return tag in function comment

    public function clearAllCaches()
    {
        $transcoderPaths = self::$plugin->getSettings()->transcoderPaths;

        foreach ($transcoderPaths as $key => $value) {
            $dir = Craft::parseEnv($value);

The function Craft::parseEnv() has been deprecated: in 3.7.29. [[App::parseEnv()]] should be used instead.

            try {
                FileHelper::clearDirectory($dir);

It seems like $dir can also be of type boolean and null; however, parameter $dir of craft\helpers\FileHelper::clearDirectory() does only seem to accept string, maybe add an additional type check?

                Craft::info(
                    Craft::t(
                        'transcoder',
                        '{name} cache directory cleared',
                        ['name' => $key]
                    ),
                    __METHOD__
                );
            } catch (ErrorException $e) {
                // the directory doesn't exist
                Craft::error($e->getMessage(), __METHOD__);
            }
        }
    }

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

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

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

    /**
     * Add in our Craft components
     */

Missing @return tag in function comment

    protected function addComponents()
    {
        // Register our variables
        Event::on(
            CraftVariable::class,
            CraftVariable::EVENT_INIT,
            function (Event $event) {
                /** @var CraftVariable $variable */

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

                $variable = $event->sender;
                $variable->set('transcoder', [

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

                    'class' => TranscoderVariable::class,
                    'viteService' => $this->vite,
                ]);

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

            }
        );
    }

    /**
     * Install our event handlers
     */

Missing @return tag in function comment

    protected function installEventHandlers()
    {
        $settings = $this->getSettings();
        // Handler: Assets::EVENT_GET_THUMB_PATH
        Event::on(
            Assets::class,
            Assets::EVENT_GET_THUMB_PATH,
            function (AssetThumbEvent $event) {
                Craft::debug(
                    'Assets::EVENT_GET_THUMB_PATH',
                    __METHOD__
                );
                /** @var Asset $asset */

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

                $asset = $event->asset;
                if (AssetsHelper::getFileKindByExtension($asset->filename) === Asset::KIND_VIDEO) {

It seems like $asset->filename can also be of type null; however, parameter $file of craft\helpers\Assets::getFileKindByExtension() does only seem to accept string, maybe add an additional type check?

                    $path = Transcoder::$plugin->transcode->handleGetAssetThumbPath($event);
                    if (!empty($path)) {
                        $event->path = $path;
                    }
                }
            }
        );
        if ($settings->clearCaches) {
            // Add the Transcode path to the list of things the Clear Caches tool can delete.
            Event::on(
                ClearCaches::class,
                ClearCaches::EVENT_REGISTER_CACHE_OPTIONS,
                function (RegisterCacheOptionsEvent $event) {
                    $event->options[] = [
                        'key' => 'transcoder',
                        'label' => Craft::t('transcoder', 'Transcoder caches'),
                        'action' => [$this, 'clearAllCaches'],
                    ];
                }
            );
        }
        // Handler: Plugins::EVENT_AFTER_INSTALL_PLUGIN
        Event::on(
            Plugins::class,
            Plugins::EVENT_AFTER_INSTALL_PLUGIN,
            function (PluginEvent $event) {
                if ($event->plugin === $this) {
                    $request = Craft::$app->getRequest();
                    if ($request->isCpRequest) {
                        Craft::$app->getResponse()->redirect(UrlHelper::cpUrl('transcoder/welcome'))->send();
                    }
                }
            }
        );
        $request = Craft::$app->getRequest();
        // Install only for non-console site requests
        if ($request->getIsSiteRequest() && !$request->getIsConsoleRequest()) {
            $this->installSiteEventListeners();
        }
    }

    /**
     * Install site event listeners for site requests only
     */

Missing @return tag in function comment

    protected function installSiteEventListeners()
    {
        // Handler: UrlManager::EVENT_REGISTER_SITE_URL_RULES
        Event::on(
            UrlManager::class,
            UrlManager::EVENT_REGISTER_SITE_URL_RULES,
            function (RegisterUrlRulesEvent $event) {
                Craft::debug(
                    'UrlManager::EVENT_REGISTER_SITE_URL_RULES',
                    __METHOD__
                );
                // Register our Control Panel routes
                $event->rules = array_merge(
                    $event->rules,
                    $this->customFrontendRoutes()
                );
            }
        );
    }

    /**
     * Return the custom frontend routes
     *
     * @return array
     */
    protected function customFrontendRoutes(): array
    {
        return [
        ];
    }
}