nystudio107 / craft-recipe

src/Recipe.php

<?php
/**
 * Recipe plugin for Craft CMS 3.x
 *
 * A comprehensive recipe FieldType for Craft CMS that includes metric/imperial
 * conversion, portion calculation, and JSON-LD microdata support
 *
 * @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\recipe;

use Craft;
use craft\base\Plugin;
use craft\events\PluginEvent;
use craft\events\RegisterComponentTypesEvent;
use craft\feedme\events\RegisterFeedMeFieldsEvent;
use craft\feedme\services\Fields as FeedMeFields;
use craft\helpers\UrlHelper;
use craft\services\Fields;
use craft\services\Plugins;
use nystudio107\recipe\fields\Recipe as RecipeField;
use nystudio107\recipe\integrations\RecipeFeedMeField;
use nystudio107\recipe\models\Settings;
use nystudio107\recipe\services\ServicesTrait;
use yii\base\Event;

/**
 * Class Recipe
 *
 * @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   Recipe

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

 *
 * @property Settings $settings
 */

Missing @category tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

class Recipe extends Plugin
{
    // Traits
    // =========================================================================

    use ServicesTrait;

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

    /**

Missing short description in doc comment

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

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

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

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

        // Register our Field
        Event::on(
            Fields::class,
            Fields::EVENT_REGISTER_FIELD_TYPES,
            static function(RegisterComponentTypesEvent $event): void {

Expected 1 space after FUNCTION keyword; 0 found

                $event->types[] = RecipeField::class;
            }
        );

        // Show our "Welcome to Recipe" message
        Event::on(
            Plugins::class,
            Plugins::EVENT_AFTER_INSTALL_PLUGIN,
            function(PluginEvent $event): void {

Expected 1 space after FUNCTION keyword; 0 found

                if (($event->plugin === $this) && !Craft::$app->getRequest()->getIsConsoleRequest()) {

The condition $event->plugin === $this is always false.

                    Craft::$app->getResponse()->redirect(UrlHelper::cpUrl('recipe/welcome'))->send();
                }
            }
        );

        $feedMeInstalled = Craft::$app->getPlugins()->isPluginInstalled('feed-me') && Craft::$app->getPlugins()->isPluginEnabled('feed-me');

        if ($feedMeInstalled) {
            Event::on(FeedMeFields::class, FeedMeFields::EVENT_REGISTER_FEED_ME_FIELDS, function(RegisterFeedMeFieldsEvent $e) {

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

Expected 1 space after FUNCTION keyword; 0 found

                $e->fields[] = RecipeFeedMeField::class;
            });

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

        }

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

    /**

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
    {
        return Craft::$app->getView()->renderTemplate('recipe/settings', [

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

            'settings' => $this->settings,
        ]);

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

    }
}