nystudio107 / craft-disqus

src/twigextensions/DisqusTwigExtension.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

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\disqus\twigextensions;

use nystudio107\disqus\Disqus;
use Twig\Extension\AbstractExtension;
use Twig\Markup;
use Twig\TwigFilter;
use Twig\TwigFunction;

/**

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   Disqus

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 DisqusTwigExtension extends AbstractExtension
{
    // Public Methods
    // =========================================================================

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public function getName(): string
    {
        return 'Disqus';
    }

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public function getFilters(): array
    {
        return [
            new TwigFilter('disqusEmbed', [$this, 'disqusEmbed']),
            new TwigFilter('disqusCount', [$this, 'disqusCount']),
        ];
    }

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public function getFunctions(): array
    {
        return [
            new TwigFunction('disqusEmbed', [$this, 'disqusEmbed']),
            new TwigFunction('disqusCount', [$this, 'disqusCount']),
        ];
    }

    /**

Missing short description in doc comment

     * @param string $disqusIdentifier

Missing parameter comment

     * @param string $disqusTitle

Missing parameter comment

     * @param string $disqusUrl

Missing parameter comment

     * @param string $disqusCategoryId

Missing parameter comment

     * @param string $disqusLanguage

Missing parameter comment

     * @param array $scriptAttributes

Missing parameter comment

Expected 2 spaces after parameter type; 1 found

     *
     * @return Markup
     */
    public function disqusEmbed(
        string $disqusIdentifier = "",
        string $disqusTitle = "",
        string $disqusUrl = "",
        string $disqusCategoryId = "",
        string $disqusLanguage = "",
        array  $scriptAttributes = [],
    ): Markup {
        return Disqus::$plugin->disqusService->outputEmbedTag(
            $disqusIdentifier,
            $disqusTitle,
            $disqusUrl,
            $disqusCategoryId,
            $disqusLanguage,
            $scriptAttributes
        );
    }

    /**

Missing short description in doc comment

     * @param string $disqusIdentifier

Missing parameter comment

     *
     * @return int
     */
    public function disqusCount(
        string $disqusIdentifier = "",
    ): int {
        return Disqus::$plugin->disqusService->getCommentsCount(
            $disqusIdentifier
        );
    }
}