nystudio107 / craft-disqus

src/models/Settings.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\models;

use craft\base\Model;
use craft\behaviors\EnvAttributeParserBehavior;
use craft\helpers\App;
use yii\behaviors\AttributeTypecastBehavior;

/**

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 Settings extends Model
{
    // Public Properties
    // =========================================================================

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

     * @var string
     */
    public string $disqusShortname = '';

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

     * @var string
     */
    public string $disqusPublicKey = '';

    /**

Missing short description in doc comment

     * @var string
     */
    public string $disqusSecretKey = '';

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

     * @var string
     */
    public string $loginName = '';

    /**

Missing short description in doc comment

     * @var string
     */
    public string $loginButton = '';

    /**

Missing short description in doc comment

     * @var string
     */
    public string $loginIcon = '';

    /**

Missing short description in doc comment

     * @var string
     */
    public string $loginUrl = '';

    /**

Missing short description in doc comment

     * @var string
     */
    public string $loginLogoutUrl = '';

    /**

Missing short description in doc comment

     * @var int
     */
    public int $loginWidth = 800;

    /**

Missing short description in doc comment

     * @var int
     */
    public int $loginHeight = 400;

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

    /**

Missing short description in doc comment

     * @return string the parsed secret key (e.g. 'XXXXXXXXXXX')
     */
    public function getDisqusSecretKey(): string
    {
        return App::parseEnv($this->disqusSecretKey);

The expression return craft\helpers\App::parseEnv($this->disqusSecretKey) could return the type null which is incompatible with the type-hinted return string. Consider adding an additional type-check to rule them out.

    }

    /**

Missing short description in doc comment

     * @return string the parsed public key (e.g. 'XXXXXXXXXXX')
     */
    public function getDisqusPublicKey(): string
    {
        return App::parseEnv($this->disqusPublicKey);

The expression return craft\helpers\App::parseEnv($this->disqusPublicKey) could return the type null which is incompatible with the type-hinted return string. Consider adding an additional type-check to rule them out.

    }

    /**

Missing short description in doc comment

     * @return string
     */
    public function getDisqusShortname(): string
    {
        return $this->disqusShortname;
    }

    /**

Missing short description in doc comment

     * @return bool
     */
    public function getUseSSO(): bool
    {
        return $this->useSSO;
    }

    /**

Missing short description in doc comment

     * @return bool
     */
    public function getCustomLogin(): bool
    {
        return $this->customLogin;
    }

    /**

Missing short description in doc comment

     * @return string
     */
    public function getLoginName(): string
    {
        return App::parseEnv($this->loginName);

The expression return craft\helpers\App::parseEnv($this->loginName) could return the type null which is incompatible with the type-hinted return string. Consider adding an additional type-check to rule them out.

    }

    /**

Missing short description in doc comment

     * @return string
     */
    public function getLoginButton(): string
    {
        return App::parseEnv($this->loginButton);

The expression return craft\helpers\App::parseEnv($this->loginButton) could return the type null which is incompatible with the type-hinted return string. Consider adding an additional type-check to rule them out.

    }

    /**

Missing short description in doc comment

     * @return string
     */
    public function getLoginIcon(): string
    {
        return App::parseEnv($this->loginIcon);

The expression return craft\helpers\App::parseEnv($this->loginIcon) could return the type null which is incompatible with the type-hinted return string. Consider adding an additional type-check to rule them out.

    }

    /**

Missing short description in doc comment

     * @return string
     */
    public function getLoginUrl(): string
    {
        return App::parseEnv($this->loginUrl);

The expression return craft\helpers\App::parseEnv($this->loginUrl) could return the type null which is incompatible with the type-hinted return string. Consider adding an additional type-check to rule them out.

    }

    /**

Missing short description in doc comment

     * @return string
     */
    public function getLoginLogoutUrl(): string
    {
        return App::parseEnv($this->loginLogoutUrl);

The expression return craft\helpers\App::parseEnv($this->loginLogoutUrl) could return the type null which is incompatible with the type-hinted return string. Consider adding an additional type-check to rule them out.

    }

    /**

Missing short description in doc comment

     * @return int
     */
    public function getLoginWidth(): int
    {
        return $this->loginWidth;
    }

    /**

Missing short description in doc comment

     * @return int
     */
    public function getLoginHeight(): int
    {
        return $this->loginHeight;
    }

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public function rules(): array
    {
        return [
            ['lazyLoadDisqus', 'boolean'],
            ['lazyLoadDisqus', 'default', 'value' => false],
            ['disqusShortname', 'string'],
            ['disqusShortname', 'default', 'value' => ''],
            ['useSSO', 'boolean'],
            ['useSSO', 'default', 'value' => false],
            ['disqusPublicKey', 'string'],
            ['disqusPublicKey', 'default', 'value' => ''],
            ['disqusSecretKey', 'string'],
            ['disqusSecretKey', 'default', 'value' => ''],
            ['customLogin', 'boolean'],
            ['customLogin', 'default', 'value' => false],
            ['loginName', 'string'],
            ['loginName', 'default', 'value' => ''],
            ['loginButton', 'string'],
            ['loginButton', 'default', 'value' => ''],
            ['loginIcon', 'string'],
            ['loginIcon', 'default', 'value' => ''],
            ['loginUrl', 'string'],
            ['loginUrl', 'default', 'value' => ''],
            ['loginLogoutUrl', 'string'],
            ['loginLogoutUrl', 'default', 'value' => ''],
            ['loginWidth', 'integer', 'min' => 400, 'max' => 2000],
            ['loginWidth', 'default', 'value' => 800],
            ['loginHeight', 'integer', 'min' => 200, 'max' => 1000],
            ['loginHeight', 'default', 'value' => 400],
        ];
    }

    /**

Missing short description in doc comment

     * @return array
     */
    public function behaviors(): array
    {
        return [
            'parser' => [
                'class' => EnvAttributeParserBehavior::class,
                'attributes' => [
                    'loginName',
                    'loginButton',
                    'loginIcon',
                    'loginUrl',
                    'loginLogoutUrl',
                    'disqusPublicKey',
                    'disqusSecretKey',
                ],
            ],
            'typecast' => [
                'class' => AttributeTypecastBehavior::class,
                // 'attributeTypes' will be composed automatically according to `rules()`
            ],
        ];
    }
}