CheckPluginAbstract::checkRequirements() - Code Metrics - Inspection of "~" - turnaev/monitor-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( a2df97...e9a9f0 )

by Vladimir

created 2018-10-12 13:26 UTC

CheckPluginAbstract::checkRequirements() A

↳ Parent: CheckPluginAbstract

Complexity

Conditions	1
Paths	1

Size

Total Lines	2
Code Lines	0

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	1
CRAP Score	1

Importance

Changes

Metric	Value
eloc	0
dl	0
loc	2
ccs	1
cts	1
cp	1
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	1
crap	1

<?php

/**

 * This file is part of the `tvi/monitor-bundle` project.

 * (c) https://github.com/turnaev/monitor-bundle/graphs/contributors

 * For the full copyright and license information, please view the LICENSE.md

 * file that was distributed with this source code.

*/

Coding Style introduced 2018-09-26 08:01 UTC by

PHP version not specified

Coding Style introduced 2018-09-26 08:01 UTC by

Missing @category tag in file comment

Coding Style introduced 2018-09-26 08:01 UTC by

Missing @package tag in file comment

Coding Style introduced 2018-09-26 08:01 UTC by

Missing @author tag in file comment

Coding Style introduced 2018-09-26 08:01 UTC by

Missing @license tag in file comment

Coding Style introduced 2018-09-26 08:01 UTC by

Missing @link tag in file comment

namespace Tvi\MonitorBundle\Check;

use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;

use Symfony\Component\Config\Definition\Builder\NodeDefinition;

use Symfony\Component\Config\Definition\Builder\TreeBuilder;

use Tvi\MonitorBundle\Exception\FeatureRequired;

/**

Coding Style introduced 2018-09-27 10:13 UTC by

Missing short description in doc comment

 * @author Vladimir Turnaev <[email protected]>

*/

Coding Style introduced 2018-09-24 09:59 UTC by

Missing @category tag in class comment

Coding Style introduced 2018-09-24 09:59 UTC by

Missing @package tag in class comment

Coding Style introduced 2018-09-24 09:59 UTC by

Missing @license tag in class comment

Coding Style introduced 2018-09-24 09:59 UTC by

Missing @link tag in class comment

abstract class CheckPluginAbstract implements CheckPluginInterface

    const IMPORTANCE_EMERGENCY = 'EMERGENCY';

    const IMPORTANCE_WARNING = 'WARNING';

    const IMPORTANCE_NOTE = 'NOTE';

    const IMPORTANCE_INFO = 'INFO';

/**

Coding Style introduced 2018-10-12 13:32 UTC by

Missing short description in doc comment

     * @return string[]

*/

    public static function getImportances(): array

        return [

            self::IMPORTANCE_EMERGENCY => self::IMPORTANCE_EMERGENCY,

            self::IMPORTANCE_WARNING => self::IMPORTANCE_WARNING,

            self::IMPORTANCE_NOTE => self::IMPORTANCE_NOTE,

            self::IMPORTANCE_INFO => self::IMPORTANCE_INFO,

];

/**

Coding Style introduced 2018-10-12 13:32 UTC by

Missing short description in doc comment

Coding Style introduced 2018-10-12 13:32 UTC by

Parameter $checkSettings should have a doc-comment as per coding-style.

     * @throws FeatureRequired

*/

Coding Style introduced 2018-10-08 12:21 UTC by

Missing @return tag in function comment

    public function checkRequirements(array $checkSettings)

/**

Coding Style introduced 2018-10-04 07:50 UTC by

Missing short description in doc comment

Coding Style introduced 2018-10-04 07:50 UTC by

Parameter $builder should have a doc-comment as per coding-style.

     * @return NodeDefinition|ArrayNodeDefinition

*/

    public function checkConf(TreeBuilder $builder): NodeDefinition

        $node = $builder

            ->root(static::CHECK_NAME, 'array')

            ->info(static::DESCR); //--

        $this->_check($node);

        return $node;

/**

Coding Style introduced 2018-10-04 07:50 UTC by

Missing short description in doc comment

Coding Style introduced 2018-10-04 07:50 UTC by

Parameter $builder should have a doc-comment as per coding-style.

     * @return NodeDefinition|ArrayNodeDefinition

*/

    public function checkFactoryConf(TreeBuilder $builder): NodeDefinition

        $node = $builder

            ->root(static::CHECK_NAME.'_factory', 'array')

            ->info(static::DESCR)

            ->children()

                ->arrayNode('items')

Coding Style introduced 2018-10-04 11:37 UTC by

Object operator not indented correctly; expected 12 spaces but found 16

                    ->prototype('array'); //--

Coding Style introduced 2018-09-24 09:59 UTC by

Object operator not indented correctly; expected 12 spaces but found 20

        $node = $this->_check($node)

                    ->end()

Coding Style introduced 2018-10-04 07:50 UTC by

Object operator not indented correctly; expected 12 spaces but found 20

                ->end()

Bug introduced 2018-10-04 07:50 UTC by

The method end() does not exist on Symfony\Component\Config...der\NodeParentInterface. It seems like you code against a sub-type of said class. However, the method does not exist in Symfony\Component\Config...ion\Builder\TreeBuilder. Are you sure you never get one of those? ( Ignorable by Annotation )

Coding Style introduced 2018-10-04 07:50 UTC by

Object operator not indented correctly; expected 12 spaces but found 16

            ->end();

        $this->_addition($node);

        return $node;

/**

Coding Style introduced 2018-10-04 07:50 UTC by

Missing short description in doc comment

     * @param NodeDefinition|ArrayNodeDefinition $node

Coding Style introduced 2018-09-27 10:13 UTC by

Missing parameter comment

     * @return NodeDefinition|ArrayNodeDefinition

*/

    protected function _addition(NodeDefinition $node): NodeDefinition

Coding Style introduced 2018-10-04 07:50 UTC by

Protected method name "CheckPluginAbstract::_addition" must not be prefixed with an underscore

        $this->_group($node);

        $this->_tags($node);

        $this->_importance($node);

        $this->_label($node);

        $this->_descr($node);

        return $node;

100

101

/**

Coding Style introduced 2018-10-04 07:50 UTC by

Missing short description in doc comment

102

     * @param NodeDefinition|ArrayNodeDefinition $node

Coding Style introduced 2018-10-04 07:50 UTC by

Missing parameter comment

103

104

     * @return NodeDefinition|ArrayNodeDefinition

105

*/

106

    abstract protected function _check(NodeDefinition $node): NodeDefinition;

Coding Style introduced 2018-10-03 06:30 UTC by

Protected method name "CheckPluginAbstract::_check" must not be prefixed with an underscore

107

108

/**

Coding Style introduced 2018-10-04 07:50 UTC by

Missing short description in doc comment

109

     * @param NodeDefinition|ArrayNodeDefinition $node

Coding Style introduced 2018-10-04 07:50 UTC by

Missing parameter comment

110

111

     * @return NodeDefinition|ArrayNodeDefinition

112

*/

113

    protected function _label(NodeDefinition $node): NodeDefinition

Coding Style introduced 2018-10-03 06:30 UTC by

Protected method name "CheckPluginAbstract::_label" must not be prefixed with an underscore

114

115

        return $node

116

            ->children()

117

                ->scalarNode('label')->defaultNull()->end()

Coding Style introduced 2018-09-24 09:59 UTC by

Object operator not indented correctly; expected 12 spaces but found 16

118

            ->end();

119

120

121

/**

Coding Style introduced 2018-10-04 07:50 UTC by

Missing short description in doc comment

122

     * @param NodeDefinition|ArrayNodeDefinition $node

Coding Style introduced 2018-10-04 07:50 UTC by

Missing parameter comment

123

124

     * @return NodeDefinition|ArrayNodeDefinition

125

*/

126

    protected function _importance(ArrayNodeDefinition $node): NodeDefinition

Coding Style introduced 2018-10-12 13:32 UTC by

Protected method name "CheckPluginAbstract::_importance" must not be prefixed with an underscore

127

128

        return $node

129

            ->children()

130

                ->scalarNode('importance')

Coding Style introduced 2018-10-12 13:32 UTC by

Object operator not indented correctly; expected 12 spaces but found 16

131

                    ->validate()

Coding Style introduced 2018-10-12 13:32 UTC by

Object operator not indented correctly; expected 12 spaces but found 20

132

                        ->ifTrue( function($value) {

Coding Style introduced 2018-10-12 13:32 UTC by

Object operator not indented correctly; expected 12 spaces but found 24

Coding Style introduced 2018-10-12 13:32 UTC by

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

Coding Style introduced 2018-10-12 13:32 UTC by

Expected 1 space after FUNCTION keyword; 0 found

133

                            if($value === null) {

Coding Style introduced 2018-10-12 13:32 UTC by

Expected "if (...) {\n"; found "if(...) {\n"

134

                                return false;

135

                            } else if(in_array($value, self::getImportances())) {

Coding Style introduced 2018-10-12 13:32 UTC by

Expected "} else if (...) \n"; found " else if(...) {\n"

Coding Style introduced 2018-10-12 13:32 UTC by

Expected "if (...) {\n"; found "if(...) {\n"

136

                                return false;

137

138

139

                            return true;

140

})

Coding Style introduced 2018-10-12 13:32 UTC by

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

141

                        ->thenInvalid(sprintf('importance has to one of value [%s]', implode(', ', self::getImportances())))

142

                    ->end()

143

                    ->defaultNull()

144

                ->end()

145

            ->end();

146

147

148

/**

Coding Style introduced 2018-10-04 07:50 UTC by

Missing short description in doc comment

149

     * @param NodeDefinition|ArrayNodeDefinition $node

Coding Style introduced 2018-10-04 07:50 UTC by

Missing parameter comment

150

151

     * @return NodeDefinition|ArrayNodeDefinition

152

*/

153

    protected function _group(NodeDefinition $node): NodeDefinition

Coding Style introduced 2018-10-03 06:30 UTC by

Protected method name "CheckPluginAbstract::_group" must not be prefixed with an underscore

154

155

        return $node

156

            ->children()

157

                ->scalarNode('group')

Coding Style introduced 2018-10-04 07:50 UTC by

Object operator not indented correctly; expected 12 spaces but found 16

158

                    ->cannotBeEmpty()

Coding Style introduced 2018-10-04 07:50 UTC by

Object operator not indented correctly; expected 12 spaces but found 20

159

                ->end()

Coding Style introduced 2018-10-04 07:50 UTC by

Object operator not indented correctly; expected 12 spaces but found 16

160

                ->scalarNode('_group')

Coding Style introduced 2018-09-24 09:59 UTC by

Object operator not indented correctly; expected 12 spaces but found 16

161

                    ->defaultValue(static::GROUP)

Coding Style introduced 2018-09-24 09:59 UTC by

Object operator not indented correctly; expected 12 spaces but found 20

162

                    ->cannotBeOverwritten()

Coding Style introduced 2018-10-04 07:50 UTC by

Object operator not indented correctly; expected 12 spaces but found 20

163

                ->end()

Coding Style introduced 2018-09-24 09:59 UTC by

Object operator not indented correctly; expected 12 spaces but found 16

164

            ->end();

165

166

167

/**

Coding Style introduced 2018-10-04 07:50 UTC by

Missing short description in doc comment

168

     * @param NodeDefinition|ArrayNodeDefinition $node

Coding Style introduced 2018-10-04 07:50 UTC by

Missing parameter comment

169

170

     * @return NodeDefinition|ArrayNodeDefinition

171

*/

172

    protected function _tags(NodeDefinition $node): NodeDefinition

Coding Style introduced 2018-10-03 06:30 UTC by

Protected method name "CheckPluginAbstract::_tags" must not be prefixed with an underscore

173

174

        return $node

175

            ->children()

176

                ->arrayNode('tags')

Coding Style introduced 2018-09-24 09:59 UTC by

Object operator not indented correctly; expected 12 spaces but found 16

177

                    ->prototype('scalar')->end()

Coding Style introduced 2018-09-24 09:59 UTC by

Object operator not indented correctly; expected 12 spaces but found 20

178

                ->end()

Coding Style introduced 2018-09-24 09:59 UTC by

Object operator not indented correctly; expected 12 spaces but found 16

179

            ->end();

180

181

182

/**

Coding Style introduced 2018-10-12 13:32 UTC by

Missing short description in doc comment

183

     * @param NodeDefinition|ArrayNodeDefinition $node

Coding Style introduced 2018-10-12 13:32 UTC by

Missing parameter comment

184

185

     * @return NodeDefinition|ArrayNodeDefinition

186

*/

187

    protected function _descr(NodeDefinition $node): NodeDefinition

Coding Style introduced 2018-10-04 07:50 UTC by

Protected method name "CheckPluginAbstract::_descr" must not be prefixed with an underscore

188

189

        return $node

190

            ->children()

191

                ->scalarNode('descr')

Coding Style introduced 2018-10-04 07:50 UTC by

Object operator not indented correctly; expected 12 spaces but found 16

192

                    ->defaultNull()

Coding Style introduced 2018-10-04 07:50 UTC by

Object operator not indented correctly; expected 12 spaces but found 20

193

                ->end()

Coding Style introduced 2018-10-04 07:50 UTC by

Object operator not indented correctly; expected 12 spaces but found 16

194

            ->end();

195

196

197

turnaev / monitor-bundle

Push — master ( a2df97...e9a9f0 )

CheckPluginAbstract::checkRequirements() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like