nystudio107 / craft-similar

src/Similar.php

<?php
/**
 * Similar plugin for Craft CMS 3.x
 *
 * Similar for Craft lets you find elements, Entries, Categories, Commerce Products, etc, that are similar, based on... other related elements.
 *
 * @link      https://nystudio107.com/

The tag in position 1 should be the @copyright tag

 * @copyright Copyright (c) 2018 nystudio107.com

@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\similar;

use Craft;
use craft\base\Element;
use craft\base\Plugin;
use craft\elements\db\ElementQuery;
use craft\events\PopulateElementEvent;
use craft\web\twig\variables\CraftVariable;
use nystudio107\similar\behaviors\CountBehavior;
use nystudio107\similar\services\ServicesTrait;
use nystudio107\similar\variables\SimilarVariable;
use yii\base\Event;

/**
 * Class Similar
 *
 * @author    nystudio107.com

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   Similar

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 Similar extends Plugin
{
    // Traits
    // =========================================================================

    use ServicesTrait;

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

    /**

Missing short description in doc comment

     * @var ?Similar
     */
    public static ?Similar $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 = false;

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

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public function init(): void
    {
        parent::init();
        self::$plugin = $this;

        Event::on(
            CraftVariable::class,
            CraftVariable::EVENT_INIT,
            static function(Event $event): void {

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('similar', SimilarVariable::class);
            }
        );
        Event::on(
            ElementQuery::class,
            ElementQuery::EVENT_AFTER_POPULATE_ELEMENT,
            static function(PopulateElementEvent $event): void {

Expected 1 space after FUNCTION keyword; 0 found

                /** @var Element $element */

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

                $element = $event->element;
                $element->attachBehavior('myCountBehavior', CountBehavior::class);
            });

This line of the multi-line function call does not seem to be indented correctly. Expected 8 spaces, but found 12.

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

        Craft::info(
            Craft::t(
                'similar',
                '{name} plugin loaded',
                ['name' => $this->name]
            ),
            __METHOD__
        );
    }

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