nystudio107 / craft-disqus

src/Disqus.php

<?php
/**
 * Disqus plugin for Craft CMS 3.x
 *
 * Integrates the Disqus commenting system into Craft 3 websites, including
 * Single Sign On (SSO) and custom login/logout URLs
 *
 * @link      https://nystudio107.com
 * @copyright Copyright (c) 2017 nystudio107
 */

namespace nystudio107\disqus;

use Craft;
use craft\base\Plugin;
use craft\web\twig\variables\CraftVariable;
use nystudio107\disqus\models\Settings;
use nystudio107\disqus\services\DisqusService;
use nystudio107\disqus\twigextensions\DisqusTwigExtension;
use nystudio107\disqus\variables\DisqusVariable;
use yii\base\Event;

/**
 * Class Disqus
 *
 * @author    nystudio107
 * @package   Disqus
 * @since     1.0.0
 *
 * @property  DisqusService $disqusService
 */
class Disqus extends Plugin
{
    // Static Properties
    // =========================================================================

    /**
     * @var ?Disqus
     */
    public static ?Disqus $plugin = null;

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

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

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

    // Static Methods
    // =========================================================================

    /**

Missing short description in doc comment

     * @inheritdoc
     */
    public function __construct($id, $parent = null, array $config = [])
    {
        $config['components'] = [
            'disqusService' => DisqusService::class,
        ];

        parent::__construct($id, $parent, $config);
    }

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

    /**
     * @inheritdoc
     */
    public function init(): void
    {
        parent::init();
        self::$plugin = $this;
        Event::on(
            CraftVariable::class,
            CraftVariable::EVENT_INIT,
            static function(Event $event) {

Expected 1 space after FUNCTION keyword; 0 found

                /** @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('disqus', DisqusVariable::class);
            }
        );
        Craft::$app->view->registerTwigExtension(new DisqusTwigExtension());
        Craft::info(
            Craft::t(
                'disqus',
                '{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(): Settings
    {
        return new Settings();
    }

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

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