Issues (1181)

src/base/ObjectParserInterface.php (24 issues)

1
<?php
2
/**
3
 * Twigfield for Craft CMS
4
 *
5
 * Provides a twig editor field with Twig & Craft API autocomplete
6
 *
7
 * @link      https://nystudio107.com
0 ignored issues
show
The tag in position 1 should be the @copyright tag
Loading history...
8
 * @copyright Copyright (c) 2022 nystudio107
0 ignored issues
show
@copyright tag must contain a year and the name of the copyright holder
Loading history...
9
 */
0 ignored issues
show
PHP version not specified
Loading history...
Missing @category tag in file comment
Loading history...
Missing @package tag in file comment
Loading history...
Missing @author tag in file comment
Loading history...
Missing @license tag in file comment
Loading history...
10
11
namespace nystudio107\twigfield\base;
12
13
/**
0 ignored issues
show
Missing short description in doc comment
Loading history...
14
 * @author    nystudio107
0 ignored issues
show
The tag in position 1 should be the @package tag
Loading history...
Content of the @author tag must be in the form "Display Name <[email protected]>"
Loading history...
Tag value for @author tag indented incorrectly; expected 2 spaces but found 4
Loading history...
15
 * @package   twigfield
0 ignored issues
show
Package name "twigfield" is not valid; consider "Twigfield" instead
Loading history...
Tag value for @package tag indented incorrectly; expected 1 spaces but found 3
Loading history...
16
 * @since     1.0.12
0 ignored issues
show
The tag in position 3 should be the @author tag
Loading history...
Tag value for @since tag indented incorrectly; expected 3 spaces but found 5
Loading history...
17
 */
0 ignored issues
show
Missing @category tag in class comment
Loading history...
Missing @license tag in class comment
Loading history...
Missing @link tag in class comment
Loading history...
18
interface ObjectParserInterface
19
{
20
    // Public Methods
21
    // =========================================================================
22
23
    /**
24
     * Parse the object passed in, including any properties or methods
25
     *
26
     * @param string $name
0 ignored issues
show
Missing parameter comment
Loading history...
27
     * @param $object
0 ignored issues
show
Missing parameter comment
Loading history...
28
     * @param int $recursionDepth
0 ignored issues
show
Missing parameter comment
Loading history...
Expected 4 spaces after parameter type; 1 found
Loading history...
29
     * @param string $path
0 ignored issues
show
Missing parameter comment
Loading history...
30
     */
0 ignored issues
show
Missing @return tag in function comment
Loading history...
31
    public function parseObject(string $name, $object, int $recursionDepth, string $path = ''): void;
32
}
33