nystudio107 / craft-icalendar

src/variables/ICalendarVariable.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) 2019 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\variables;

use craft\helpers\Template;
use ICal\ICal;
use nystudio107\icalendar\ICalendar;
use Twig\Markup;

/**

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   ICalendar

Tag value for @package tag indented incorrectly; expected 1 spaces but found 3

 * @since     1.1.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 ICalendarVariable
{
    // Public Methods
    // =========================================================================

    /**
     * Format the passed in $text as per the iCalendar RFC 2445 spec:
     * https://icalendar.org/validator.html
     *
     * @param string $text

Missing parameter comment

     *
     * @return Markup
     */
    public function rfc2445(string $text): Markup
    {
        return Template::raw(ICalendar::$plugin->convert->rfc2445($text));
    }

    /**
     * Return the ICal object (or null) for the events feed
     *
     * @param mixed|array|string $files

Missing parameter comment

     * @param array $config

Missing parameter comment

Expected 14 spaces after parameter type; 1 found

     *
     * @return ICal
     */
    public function ics(mixed $files, array $config = []): ICal
    {
        return ICalendar::$plugin->parse->ics($files, $config);
    }
}