nystudio107 / craft-icalendar

src/ICalendar.php

<?php
/**
 * iCalendar plugin for Craft CMS 3.x

Doc comment short description must start with a capital letter

 *
 * Tools for parsing & formatting the RFC 2445 iCalendar (.ics) specification
 *
 * @link      https://nystudio107.com

The tag in position 1 should be the @copyright tag

 * @copyright Copyright (c) 2018 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\icalendar;

use Craft;
use craft\base\Plugin;
use craft\web\twig\variables\CraftVariable;
use nystudio107\icalendar\services\Convert as ConvertService;
use nystudio107\icalendar\services\Parse as ParseService;
use nystudio107\icalendar\twigextensions\ICalendarTwigExtension;
use nystudio107\icalendar\variables\ICalendarVariable;
use yii\base\Event;

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

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  ConvertService $convert

Tag value for @property tag indented incorrectly; expected 1 spaces but found 2

 * @property  ParseService $parse

Tag value for @property tag indented incorrectly; expected 1 spaces but found 2

 */

Missing @category tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

class ICalendar extends Plugin
{
    // Static Properties
    // =========================================================================

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

     * @var ?ICalendarVariable
     */
    public static ?ICalendarVariable $variable = 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

Parameter $id should have a doc-comment as per coding-style.

Parameter $parent should have a doc-comment as per coding-style.

Parameter $config should have a doc-comment as per coding-style.

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

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

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public function init(): void
    {
        parent::init();
        self::$plugin = $this;
        self::$variable = new ICalendarVariable();
        // Register Twig extension
        Craft::$app->view->registerTwigExtension(new ICalendarTwigExtension());
        // Register variable
        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('icalendar', self::$variable);
            }
        );

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

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