nystudio107\codefield\models\CodeData

Complexity

Total Complexity

3

Size/Duplication

Total Lines	46
Duplicated Lines	0 %

Importance

Changes	2
Bugs	1	Features	1

3 Methods

Rating	Name	Duplication	Size	Complexity
A	__toString()	0	3	1
A	rules()	0	9	1
A	init()	0	3	1

<?php
/**
 * Code Field plugin for Craft CMS
 *
 * Provides a Code Field that has a full-featured code editor with syntax highlighting & autocomplete
 *
 * @link      https://nystudio107.com

The tag in position 1 should be the @copyright tag

 * @copyright Copyright (c) 2022 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\codefield\models;


use craft\base\Model;

/**

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   Code Field

Package name "Code Field" is not valid; consider "Code_Field" instead

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

 * @since     3.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 CodeData extends Model
{
    // Public Properties
    // =========================================================================

    /**

Missing short description in doc comment

     * @var string The value of the Code Editor field
     */
    public $value;

    /**

Missing short description in doc comment

     * @var string The language of the Code Editor field
     */
    public $language;

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

    /**

Missing short description in doc comment

     * @return string
     */
    public function __toString(): string
    {
        return (string)$this->value;
    }

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public function init()
    {
        parent::init();
    }

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public function rules(): array
    {
        $rules = parent::rules();
        $rules = array_merge($rules, [

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

            ['value', 'string'],
            ['language', 'string'],
        ]);

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

        return $rules;
    }
}