turnaev / monitor-bundle

src/Check/CheckPluginAbstract.php

<?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.
 */

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

Missing @link tag in file comment

namespace Tvi\MonitorBundle\Check;

use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
use Symfony\Component\Config\Definition\Builder\TreeBuilder;
use Tvi\MonitorBundle\Exception\FeatureRequired;

/**

Missing short description in doc comment

 * @author Vladimir Turnaev <turnaev@gmail.com>
 */

Missing @category tag in class comment

Missing @package tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

abstract class CheckPluginAbstract implements CheckPluginInterface
{
    /**

Missing short description in doc comment

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

     * @throws FeatureRequired
     */

Missing @return tag in function comment

    public function checkRequirements(array $checkSettings)
    {
    }

    public function checkConf(TreeBuilder $builder): ArrayNodeDefinition

Missing doc comment for function checkConf()

    {
        $node = $builder
            ->root(static::CHECK_NAME, 'array')
            ->info(static::DESCR); //--

        $this->_check($node);

        return $node;

The expression return $node returns the type Symfony\Component\Config\Definition\Builder\NodeDefinition which includes types incompatible with the type-hinted return Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition.

    }

    public function checkFactoryConf(TreeBuilder $builder): ArrayNodeDefinition

Missing doc comment for function checkFactoryConf()

    {
        $node = $builder
            ->root(static::CHECK_NAME.'_factory', 'array')
            ->info(static::DESCR)
            ->children()
                ->arrayNode('items')

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

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

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

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

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

                ->end()

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

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

            ->end();

        $this->_addition($node);

        return $node;
    }

    protected function _addition(ArrayNodeDefinition $node): ArrayNodeDefinition

Missing doc comment for function _addition()

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;
    }

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

Missing doc comment for function _check()

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

    protected function _label(ArrayNodeDefinition $node): ArrayNodeDefinition

Missing doc comment for function _label()

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

    {
        return $node
            ->children()
                ->scalarNode('label')->defaultNull()->end()

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

            ->end();
    }

    protected function _importance(ArrayNodeDefinition $node): ArrayNodeDefinition

Missing doc comment for function _importance()

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

    {
        return $node
            ->children()
                ->scalarNode('importance')

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

                    ->validate()

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

                        ->ifTrue(static function ($value) {

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

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

                            if (null === $value) {
                                return false;
                            } elseif (\in_array($value, CheckAbstract::getImportances(), true)) {
                                return false;
                            }

                            return true;
                        })

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

                        ->thenInvalid(sprintf('importance has to one of value [%s]', implode(', ', CheckAbstract::getImportances())))
                    ->end()
                    ->defaultNull()
                ->end()
            ->end();
    }

    protected function _group(ArrayNodeDefinition $node): ArrayNodeDefinition

Missing doc comment for function _group()

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

    {
        return $node
            ->children()
                ->scalarNode('group')

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

                    ->cannotBeEmpty()

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

                ->end()

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

                ->scalarNode('_group')

The method scalarNode() does not exist on Symfony\Component\Config\Definition\Builder\NodeParentInterface. It seems like you code against a sub-type of Symfony\Component\Config\Definition\Builder\NodeParentInterface such as Symfony\Component\Config\Definition\Builder\NodeBuilder.

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

                    ->defaultValue(static::GROUP)

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

                    ->cannotBeOverwritten()

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

                ->end()

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

            ->end();
    }

    protected function _tags(ArrayNodeDefinition $node): ArrayNodeDefinition

Missing doc comment for function _tags()

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

    {
        return $node
            ->children()
                ->arrayNode('tags')

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

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

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

                ->end()

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

            ->end();
    }

    protected function _descr(ArrayNodeDefinition $node): ArrayNodeDefinition

Missing doc comment for function _descr()

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

    {
        return $node
            ->children()
                ->scalarNode('descr')

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

                    ->defaultNull()

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

                ->end()

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

            ->end();
    }
}