rattfieldnz / shodan

src/ShodanServiceProvider.php

<?php

Class found in ".php" file; use ".inc" extension instead

This file is missing a doc comment.

The PHP open tag does not have a corresponding PHP close tag

Filename "ShodanServiceProvider.php" doesn't match the expected filename "shodanserviceprovider.php"

Missing file doc comment

namespace RattfieldNz\Shodan;

use Illuminate\Support\Arr;
use Illuminate\Support\ServiceProvider;

/**
 * Class ShodanServiceProvider.
 *
 * @category PHP

@category tag is not allowed in class comment

 *
 * @author  Rob Attfield <emailme@robertattfield.com>

@author tag is not allowed in class comment

 * @license https://github.com/rattfieldnz/shodan/blob/master/LICENSE MIT

@license tag is not allowed in class comment

 */

Missing @package tag in class comment

Missing @link tag in class comment

class ShodanServiceProvider extends ServiceProvider
{

Opening brace should be on the same line as the declaration for class ShodanServiceProvider

    const CONFIG_PATH = __DIR__.'/../config/shodan.php';

Expected at least 1 space before "."; 0 found

Expected at least 1 space after "."; 0 found

    public function boot()

Missing doc comment for function boot()

Expected 2 blank lines before function; 1 found

    {

Opening brace should be on the same line as the declaration

        $this->publishes(
            [

Short array syntax is not allowed

            self::CONFIG_PATH => config_path('shodan.php'),

This array key does not seem to be aligned correctly; expected 13 spaces, but found 12.

Array key not indented correctly; expected 16 spaces but found 12

            ], 'config'
        );
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end boot()

    public function register()

Missing doc comment for function register()

    {

Opening brace should be on the same line as the declaration

        $this->mergeConfigFrom(
            self::CONFIG_PATH,
            'shodan'
        );

        $this->app->alias(Shodan::class, 'shodan');

        $this->app->bind(
            'shodan', function () {
                return new Shodan();
            }
        );
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end register()

    /**
     * Get the services provided by the provider.
     *
     * @return array
     */
    public function provides()
    {

Opening brace should be on the same line as the declaration

        return ['shodan'];

Short array syntax is not allowed

    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end provides()

    /**
     * Console-specific booting.
     *
     * @return void
     */
    public function bootForConsole()
    {

Opening brace should be on the same line as the declaration

        // Publishing the configuration file.
        $this->publishes(
            [

Short array syntax is not allowed

            __DIR__.'/../config/shodan.php' => config_path('shodan.php'),

This array key does not seem to be aligned correctly; expected 13 spaces, but found 12.

Array key not indented correctly; expected 16 spaces but found 12

Expected at least 1 space before "."; 0 found

Expected at least 1 space after "."; 0 found

            ], 'shodan'
        );

        // Registering package commands.
        $this->commands(['shodan']);

Short array syntax is not allowed

    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end bootForConsole()

    /**
     * Merge the given configuration with the existing configuration.
     *
     * @param string $path

Missing parameter comment

     * @param string $key

Missing parameter comment

     *
     * @return void
     */
    protected function mergeConfigFrom($path, $key)

Type hint "string" missing for $path

Type hint "string" missing for $key

    {

Opening brace should be on the same line as the declaration

        $config = $this->app['config']->get($key, []);

Short array syntax is not allowed

        $this->app['config']->set($key, $this->mergeConfig($config, include $path));
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end mergeConfigFrom()

    /**
     * Merges the configs together and takes multi-dimensional arrays into account.
     *
     * @param array $original

Missing parameter comment

     * @param array $merging

Missing parameter comment

     *
     * @return array
     */
    protected function mergeConfig(array $original, array $merging)
    {

Opening brace should be on the same line as the declaration

        $array = array_merge($original, $merging);
        foreach ($original as $key => $value) {
            if (!is_array($value)) {

Expected 1 space(s) after NOT operator; 0 found

                continue;
            }

No blank line found after control structure

            if (!Arr::exists($merging, $key)) {

Expected 1 space(s) after NOT operator; 0 found

                continue;
            }

No blank line found after control structure

            if (is_numeric($key)) {
                continue;
            }

No blank line found after control structure

            $array[$key] = $this->mergeConfig($value, $merging[$key]);
        }

        return $array;
    }

Expected 2 blank lines after function; 0 found

Expected 1 blank line before closing function brace; 0 found

Expected //end mergeConfig()

}

Expected //end class

As per coding style, files should not end with a newline character.