Triadev\Leopard\Business\Dsl\Suggestion

Complexity

Total Complexity

7

Size/Duplication

Total Lines	109
Duplicated Lines	0 %

Test Coverage

Coverage

88.24%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	2
A	get()	0	5	1
A	phrase()	0	11	1
A	term()	0	11	1
A	toDsl()	0	3	1
A	completion()	0	11	1

<?php

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

namespace Triadev\Leopard\Business\Dsl;

Missing file doc comment

use ONGR\ElasticsearchDSL\Suggest\Suggest;
use Triadev\Leopard\Contract\ElasticsearchManagerContract;
use Triadev\Leopard\Facade\Leopard;

class Suggestion

Missing class doc comment

{

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

    /** @var \ONGR\ElasticsearchDSL\Search */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

    private $search;

Private member variable "search" must contain a leading underscore

Expected 1 blank line before member var; 0 found

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

    
    /** @var ElasticsearchManagerContract */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

    private $manager;

Private member variable "manager" must contain a leading underscore

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

    
    /**
     * Suggestion constructor.
     * @param ElasticsearchManagerContract $manager

There must be exactly one blank line before the tags in a doc comment

Missing parameter comment

Expected 7 spaces after parameter type; 1 found

     * @param \ONGR\ElasticsearchDSL\Search|null $search

Missing parameter comment

     */
    public function __construct(

Expected 2 blank lines before function; 1 found

        ElasticsearchManagerContract $manager,
        ?\ONGR\ElasticsearchDSL\Search $search = null

Incorrect spacing between argument "$search" and equals sign; expected 0 but found 1

Incorrect spacing between default value and equals sign for argument "$search"; expected 0 but found 1

    ) {

Opening brace should be on a new line

        $this->manager = $manager;
        $this->search = $search ?: new \ONGR\ElasticsearchDSL\Search();

Equals sign not aligned with surrounding assignments; expected 2 spaces but found 1 space

The value of a comparison must not be assigned to a variable

Inline IF statements are not allowed

Inline shorthand IF statement requires brackets around comparison

    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end __construct()

    
    /**
     * To dsl
     *
     * @return array
     */
    public function toDsl(): array
    {
        return $this->search->toArray();
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end toDsl()

    
    /**
     * Get
     *
     * @param string $index

Missing parameter comment

Tag value indented incorrectly; expected 2 spaces but found 1

     * @return array

Tag cannot be grouped with parameter tags in a doc comment

     */
    public function get(string $index): array
    {
        return Leopard::suggestStatement([

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

            'index' => $index,

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

            'body' => $this->toDsl()

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

        ]);

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

The closing parenthesis does not seem to be aligned correctly; expected 41 space(s), but found 8.

    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end get()

    
    /**
     * Term
     *
     * @param string $name

Missing parameter comment

Tag value indented incorrectly; expected 2 spaces but found 1

     * @param string $text

Missing parameter comment

Tag value indented incorrectly; expected 2 spaces but found 1

     * @param string $field

Missing parameter comment

Tag value indented incorrectly; expected 2 spaces but found 1

     * @param array $params

Missing parameter comment

Expected 2 spaces after parameter type; 1 found

Tag value indented incorrectly; expected 2 spaces but found 1

     * @return Suggestion

Tag cannot be grouped with parameter tags in a doc comment

     */
    public function term(string $name, string $text, string $field, array $params = []): Suggestion

Incorrect spacing between argument "$params" and equals sign; expected 0 but found 1

Incorrect spacing between default value and equals sign for argument "$params"; expected 0 but found 1

    {
        $this->search->addSuggest(new Suggest(

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

            $name,
            'term',
            $text,
            $field,
            $params
        ));

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

        
        return $this;
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end term()

    
    /**
     * Phrase
     *
     * @param string $name

Missing parameter comment

Tag value indented incorrectly; expected 2 spaces but found 1

     * @param string $text

Missing parameter comment

Tag value indented incorrectly; expected 2 spaces but found 1

     * @param string $field

Missing parameter comment

Tag value indented incorrectly; expected 2 spaces but found 1

     * @param array $params

Missing parameter comment

Expected 2 spaces after parameter type; 1 found

Tag value indented incorrectly; expected 2 spaces but found 1

     * @return Suggestion

Tag cannot be grouped with parameter tags in a doc comment

     */
    public function phrase(string $name, string $text, string $field, array $params = []): Suggestion

Incorrect spacing between argument "$params" and equals sign; expected 0 but found 1

Incorrect spacing between default value and equals sign for argument "$params"; expected 0 but found 1

This line exceeds maximum limit of 100 characters; contains 101 characters

    {
        $this->search->addSuggest(new Suggest(

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

            $name,
            'phrase',
            $text,
            $field,
            $params
        ));

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

        
        return $this;
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end phrase()

    
    /**
     * Term
     *
     * @param string $name

Missing parameter comment

Tag value indented incorrectly; expected 2 spaces but found 1

     * @param string $text

Missing parameter comment

Tag value indented incorrectly; expected 2 spaces but found 1

     * @param string $field

Missing parameter comment

Tag value indented incorrectly; expected 2 spaces but found 1

     * @param array $params

Missing parameter comment

Expected 2 spaces after parameter type; 1 found

Tag value indented incorrectly; expected 2 spaces but found 1

     * @return Suggestion

Tag cannot be grouped with parameter tags in a doc comment

     */
    public function completion(string $name, string $text, string $field, array $params = []): Suggestion

Incorrect spacing between argument "$params" and equals sign; expected 0 but found 1

Incorrect spacing between default value and equals sign for argument "$params"; expected 0 but found 1

This line exceeds maximum limit of 100 characters; contains 105 characters

    {
        $this->search->addSuggest(new Suggest(

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

            $name,
            'completion',
            $text,
            $field,
            $params
        ));

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

        
        return $this;
    }

Expected 2 blank lines after function; 0 found

Expected 1 blank line before closing function brace; 0 found

Expected //end completion()

}

Expected //end class

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