Issues (447)

src/services/ServicesTrait.php (22 issues)

1
<?php
2
/**
3
 * Route Map plugin for Craft CMS
4
 *
5
 * Returns a list of public routes for elements with URLs
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) 2017 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\routemap\services;
12
13
use nystudio107\routemap\services\Routes as RoutesService;
14
use yii\base\InvalidConfigException;
15
16
/**
0 ignored issues
show
Missing short description in doc comment
Loading history...
17
 * @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...
18
 * @package   routemap
0 ignored issues
show
Package name "routemap" is not valid; consider "Routemap" instead
Loading history...
Tag value for @package tag indented incorrectly; expected 1 spaces but found 3
Loading history...
19
 * @since     4.0.1
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...
20
 *
21
 * @property  RoutesService $routes
0 ignored issues
show
Tag value for @property tag indented incorrectly; expected 1 spaces but found 2
Loading history...
22
 */
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...
23
trait ServicesTrait
24
{
25
    // Public Static Methods
26
    // =========================================================================
27
28
    /**
0 ignored issues
show
Missing short description in doc comment
Loading history...
29
     * @inheritdoc
30
     */
0 ignored issues
show
Missing @return tag in function comment
Loading history...
31
    public static function config(): array
32
    {
33
        return [
34
            'components' => [
35
                'routes' => RoutesService::class,
36
            ],
37
        ];
38
    }
39
40
    // Public Methods
41
    // =========================================================================
42
43
    /**
44
     * Returns the routes service
45
     *
46
     * @return RoutesService The helper service
47
     * @throws InvalidConfigException
48
     */
49
    public function getRoutes(): RoutesService
50
    {
51
        return $this->get('routes');
0 ignored issues
show
It seems like get() must be provided by classes using this trait. How about adding it as abstract method to this trait? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-call  annotation

51
        return $this->/** @scrutinizer ignore-call */ get('routes');
Loading history...
52
    }
53
}
54