Passed
Push — v1 ( 9b2918...ee0a5e )
by Andrew
11:36 queued 04:46
created

ServicesTrait::getTranscode()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 3
Code Lines 1

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 1
Metric Value
cc 1
eloc 1
c 1
b 0
f 1
nc 1
nop 0
dl 0
loc 3
rs 10
1
<?php
2
/**
3
 * Transcoder plugin for Craft CMS
4
 *
5
 * Transcode videos to various formats, and provide thumbnails of the video
6
 *
7
 * @link      https://nystudio107.com
0 ignored issues
show
Coding Style introduced by
The tag in position 1 should be the @copyright tag
Loading history...
8
 * @copyright Copyright (c) 2022 nystudio107
0 ignored issues
show
Coding Style introduced by
@copyright tag must contain a year and the name of the copyright holder
Loading history...
9
 */
0 ignored issues
show
Coding Style introduced by
PHP version not specified
Loading history...
Coding Style introduced by
Missing @category tag in file comment
Loading history...
Coding Style introduced by
Missing @package tag in file comment
Loading history...
Coding Style introduced by
Missing @author tag in file comment
Loading history...
Coding Style introduced by
Missing @license tag in file comment
Loading history...
10
11
namespace nystudio107\transcoder\services;
12
13
use craft\helpers\ArrayHelper;
14
use nystudio107\pluginvite\services\VitePluginService;
15
use nystudio107\transcoder\assetbundles\transcoder\TranscoderAsset;
16
use yii\base\InvalidConfigException;
17
18
/**
0 ignored issues
show
Coding Style introduced by
Missing short description in doc comment
Loading history...
19
 * @author    nystudio107
0 ignored issues
show
Coding Style introduced by
The tag in position 1 should be the @package tag
Loading history...
Coding Style introduced by
Content of the @author tag must be in the form "Display Name <[email protected]>"
Loading history...
Coding Style introduced by
Tag value for @author tag indented incorrectly; expected 2 spaces but found 4
Loading history...
20
 * @package   Transcode
0 ignored issues
show
Coding Style introduced by
Tag value for @package tag indented incorrectly; expected 1 spaces but found 3
Loading history...
21
 * @since     1.2.23
0 ignored issues
show
Coding Style introduced by
The tag in position 3 should be the @author tag
Loading history...
Coding Style introduced by
Tag value for @since tag indented incorrectly; expected 3 spaces but found 5
Loading history...
22
 *
23
 * @property Transcode $transcode
24
 * @property VitePluginService $vite
25
 */
0 ignored issues
show
Coding Style introduced by
Missing @category tag in class comment
Loading history...
Coding Style introduced by
Missing @license tag in class comment
Loading history...
Coding Style introduced by
Missing @link tag in class comment
Loading history...
26
trait ServicesTrait
27
{
28
    // Public Methods
29
    // =========================================================================
30
31
    /**
0 ignored issues
show
Coding Style introduced by
Missing short description in doc comment
Loading history...
Coding Style introduced by
Parameter $id should have a doc-comment as per coding-style.
Loading history...
Coding Style introduced by
Parameter $parent should have a doc-comment as per coding-style.
Loading history...
Coding Style introduced by
Parameter $config should have a doc-comment as per coding-style.
Loading history...
32
     * @inheritdoc
33
     */
34
    public function __construct($id, $parent = null, array $config = [])
35
    {
36
        // Merge in the passed config, so it our config can be overridden by Plugins::pluginConfigs['vite']
37
        // ref: https://github.com/craftcms/cms/issues/1989
38
        $config = ArrayHelper::merge([
0 ignored issues
show
Coding Style introduced by
The opening parenthesis of a multi-line function call should be the last content on the line.
Loading history...
39
            'components' => [
40
                'transcode' => Transcode::class,
41
                // Register the vite service
42
                'vite' => [
43
                    'class' => VitePluginService::class,
44
                    'assetClass' => TranscoderAsset::class,
45
                    'useDevServer' => true,
46
                    'devServerPublic' => 'http://localhost:3001',
47
                    'serverPublic' => 'http://localhost:8000',
48
                    'errorEntry' => 'src/js/app.ts',
49
                    'devServerInternal' => 'http://craft-transcoder-buildchain:3001',
50
                    'checkDevServer' => true,
51
                ],
52
            ]
53
        ], $config);
0 ignored issues
show
Coding Style introduced by
For multi-line function calls, the closing parenthesis should be on a new line.

If a function call spawns multiple lines, the coding standard suggests to move the closing parenthesis to a new line:

someFunctionCall(
    $firstArgument,
    $secondArgument,
    $thirdArgument
); // Closing parenthesis on a new line.
Loading history...
54
55
        parent::__construct($id, $parent, $config);
56
    }
57
58
    /**
59
     * Returns the transcode service
60
     *
61
     * @return Transcode The transcode service
62
     * @throws InvalidConfigException
63
     */
64
    public function getTranscode(): Transcode
65
    {
66
        return $this->get('transcode');
0 ignored issues
show
Bug introduced by
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

66
        return $this->/** @scrutinizer ignore-call */ get('transcode');
Loading history...
67
    }
68
69
    /**
70
     * Returns the vite service
71
     *
72
     * @return VitePluginService The vite service
73
     * @throws InvalidConfigException
74
     */
75
    public function getVite(): VitePluginService
76
    {
77
        return $this->get('vite');
78
    }
79
}
80