turnaev / monitor-bundle

src/DependencyInjection/Configuration.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\DependencyInjection;

use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
use Symfony\Component\Config\Definition\Builder\TreeBuilder;
use Symfony\Component\Config\Definition\ConfigurationInterface;
use Tvi\MonitorBundle\Check\CheckPluginFinder;

/**
 * This class contains the configuration information for the bundle.
 *
 * This information is solely responsible for how the different configuration
 * sections are normalized, and merged.
 *
 * @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

class Configuration implements ConfigurationInterface
{
    /**

Missing short description in doc comment

     * @var array
     */
    private $checkPlugins = [];

Private member variable "checkPlugins" must be prefixed with an underscore

    private $checkPluginClasses = [];

Private member variable "checkPluginClasses" must be prefixed with an underscore

    /**

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

     * Configuration constructor.
     */
    public function __construct(CheckPluginFinder $pluginFinder)
    {
        $this->checkPluginClasses = $pluginFinder->find();
    }

    public function getCheckPlugins(): array

Missing doc comment for function getCheckPlugins()

    {
        return $this->checkPlugins;
    }

    /**
     * Generates the configuration tree.
     *
     * @return TreeBuilder
     */
    public function getConfigTreeBuilder()
    {
        $treeBuilder = new TreeBuilder();

        $treeBuilder->root('tvi_monitor', 'array')
            ->children()
                ->append($this->addUIViewTemplate())

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

                ->append($this->addChecksSearchPaths())

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

                ->append($this->addGroups())

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

                ->append($this->addTags())

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

                ->append($this->addReporers())

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

                ->append($this->addChecks())

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

            ->end()
        ->end();

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

        return $treeBuilder;
    }

    private function addChecks(): ArrayNodeDefinition

Private method name "Configuration::addChecks" must be prefixed with an underscore

Missing doc comment for function addChecks()

    {
        $builder = new TreeBuilder();

        $checkPligins = $this->checkPlugins;

        $addChecks = function ($rootNode) use ($checkPligins, $builder) {

The import $checkPligins is not used and could be removed.

            foreach ($this->checkPluginClasses as $checkPluginClass) {
                $checkPlugin = new $checkPluginClass();

                $confMethods = array_filter(get_class_methods($checkPlugin), static function ($n) {

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

                    return preg_match('/Conf$/', $n);
                });

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

                foreach ($confMethods as $confMethod) {

                    /* @var ArrayNodeDefinition $node */
                    $node = $checkPlugin->$confMethod($builder);
                    $checkName = $node->getNode(true)->getName();
                    $serviceName = preg_replace('/_factory$/', '', $checkName);

                    $this->checkPlugins[$checkName] = [
                        'checkServicePath' => $checkPlugin::PATH.\DIRECTORY_SEPARATOR.'check.yml',
                        'service' => $serviceName,
                        'plugin' => $checkPlugin,
                    ];

                    $rootNode->append($node);
                }
            }

            return $rootNode;
        };

        $node = $builder
            ->root('checks', 'array')
            ->beforeNormalization()
            ->always(static function ($value) {

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

                $value = $value ? $value : [];
                foreach ($value as $k => $v) {
                    $newK = str_replace('(s)', '_factory', $k);
                    if ($newK !== $k) {
                        $value[$newK] = $value[$k];
                        unset($value[$k]);
                    }
                }

                return $value;
            })

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

            ->end()
            ->children(); //--
        $node = $addChecks($node)
            ->end();

        return $node;
    }

    private function addReporers(): ArrayNodeDefinition

Missing doc comment for function addReporers()

Private method name "Configuration::addReporers" must be prefixed with an underscore

    {
        return (new TreeBuilder())
            ->root('reporters', 'array')
            ->children()
                ->arrayNode('mailer')

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

                    ->children()

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

                        ->scalarNode('recipient')

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

                            ->isRequired()

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

                            ->cannotBeEmpty()

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

                        ->end()

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

                        ->scalarNode('sender')

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

                            ->isRequired()

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

                            ->cannotBeEmpty()

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

                        ->end()

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

                        ->scalarNode('subject')

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

                            ->isRequired()

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

                            ->cannotBeEmpty()

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

                        ->end()

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

                        ->booleanNode('send_on_warning')

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

                            ->defaultTrue()

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

                        ->end()

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

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

    private function addTags(): ArrayNodeDefinition

Missing doc comment for function addTags()

Private method name "Configuration::addTags" must be prefixed with an underscore

    {
        return (new TreeBuilder())
            ->root('tags', 'array')
            ->prototype('array')

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

                ->children()

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

                    ->scalarNode('name')->end()

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

                    ->scalarNode('descr')->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();
    }

    private function addGroups(): ArrayNodeDefinition

Private method name "Configuration::addGroups" must be prefixed with an underscore

Missing doc comment for function addGroups()

    {
        return (new TreeBuilder())
            ->root('groups', 'array')
            ->prototype('array')
                ->children()

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

                    ->scalarNode('name')->end()

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

                    ->scalarNode('descr')->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();
    }

    private function addChecksSearchPaths(): ArrayNodeDefinition

Private method name "Configuration::addChecksSearchPaths" must be prefixed with an underscore

Missing doc comment for function addChecksSearchPaths()

    {
        return (new TreeBuilder())
            ->root('checks_search_paths', 'array')
            ->prototype('scalar')->end();
    }

    private function addUIViewTemplate()

Private method name "Configuration::addUIViewTemplate" must be prefixed with an underscore

Missing doc comment for function addUIViewTemplate()

    {
        return (new TreeBuilder())
            ->root('ui_view_template', 'scalar')
                ->cannotBeEmpty()

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

                ->defaultValue('@TviMonitor/UI/index.b4.html.twig');

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

    }
}