nystudio107 / craft-icalendar

src/services/Convert.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\services;

use craft\base\Component;

/**

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.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 Convert extends Component
{
    // Constants
    // =========================================================================

    protected const RFC2455_EOL = "\r\n";
    protected const RFC2455_TAB = "\t";
    protected const RFC2455_LITERAL_NEWLINE = '\n';
    protected const MAX_OCTETS = 75;

    // 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 string
     */
    public function rfc2445(string $text): string
    {
        $result = '';
        // Normalize the line breaks
        $text = str_replace(["\n", "\r\r\n"], self::RFC2455_EOL, $text);
        // Handle rich text field output, such as from Redactor, which may have line or paragraph breaks
        $text = str_replace(["</p>\r", "</P>\r"], self::RFC2455_LITERAL_NEWLINE . self::RFC2455_LITERAL_NEWLINE, $text);
        $text = str_replace(["<br>\r", "<BR>\r", "<br />\r", "<BR />\r"], self::RFC2455_LITERAL_NEWLINE, $text);
        // Split the text into separate lines
        $lines = explode(self::RFC2455_EOL, $text);
        foreach ($lines as $key => $line) {
            $result .= $this->icalSplit('', $line) . self::RFC2455_EOL;
        }

        return $result;
    }

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

    /**
     * Split the lines into RFC 2445 compatible line breaks so that no line
     * is longer than 75 octets
     * Adapted from: https://gist.github.com/hugowetterberg/81747
     *
     * @param string $preamble

Missing parameter comment

     * @param string $value

Missing parameter comment

     *
     * @return string
     */
    protected function icalSplit(string $preamble, string $value): string
    {
        $value = trim($value);
        $value = strip_tags($value);
        $value = html_entity_decode($value);
        $value = preg_replace('/\n+/', ' ', $value);
        $value = preg_replace('/\s{2,}/', ' ', $value);
        $preamble_len = mb_strlen($preamble);
        $lines = [];
        while (mb_strlen($value) > (self::MAX_OCTETS - $preamble_len)) {
            $space = (self::MAX_OCTETS - $preamble_len);
            $mbcc = $space;
            while ($mbcc) {
                $line = mb_substr($value, 0, $mbcc);
                $oct = mb_strlen($line);
                if ($oct > $space) {
                    $mbcc -= $oct - $space;
                } else {
                    $lines[] = $line;
                    $preamble_len = 1; // Still take the tab into account
                    $value = mb_substr($value, $mbcc);
                    break;
                }
            }
        }
        if (!empty($value)) {
            $lines[] = $value;
        }

        return implode(self::RFC2455_EOL . self::RFC2455_TAB, $lines);
    }
}