Triadev\Leopard\Business\Dsl\FunctionScore

Complexity

Total Complexity

10

Size/Duplication

Total Lines	162
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	decay()	0	18	1
A	weight()	0	4	1
A	script()	0	14	1
A	__construct()	0	3	1
A	getQuery()	0	3	1
A	random()	0	4	1
A	simple()	0	4	1
A	buildQueryFromSearchClosure()	0	12	2
A	field()	0	14	1

<?php

This file is missing a doc comment.

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

namespace Triadev\Leopard\Business\Dsl;

Missing file doc comment

use ONGR\ElasticsearchDSL\BuilderInterface;
use ONGR\ElasticsearchDSL\Query\Compound\FunctionScoreQuery;

class FunctionScore

Missing class doc comment

{

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

    /** @var FunctionScoreQuery */

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 $query;

Private member variable "query" must contain a leading underscore

Expected 1 blank line before member var; 0 found

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

    
    /**
     * FunctionScore constructor.
     * @param BuilderInterface $query

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

Missing parameter comment

     * @param array $params

Missing parameter comment

Expected 12 spaces after parameter type; 1 found

     */
    public function __construct(BuilderInterface $query, array $params = [])

Expected 2 blank lines before function; 1 found

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

Short array syntax is not allowed

    {
        $this->query = new FunctionScoreQuery($query, $params);
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end __construct()

    
    /**
     * Get query
     *
     * @return BuilderInterface
     */
    public function getQuery() : BuilderInterface
    {
        return $this->query;
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end getQuery()

    
    /**
     * Field
     *
     * @param string $field

Missing parameter comment

Expected 8 spaces after parameter type; 1 found

Tag value indented incorrectly; expected 2 spaces but found 1

     * @param float $factor

Missing parameter comment

Expected 9 spaces after parameter type; 1 found

Tag value indented incorrectly; expected 2 spaces but found 1

     * @param string $modifier

Missing parameter comment

Expected 8 spaces after parameter type; 1 found

Tag value indented incorrectly; expected 2 spaces but found 1

     * @param \Closure|null $search

Missing parameter comment

Tag value indented incorrectly; expected 2 spaces but found 1

     * @return FunctionScore

Tag cannot be grouped with parameter tags in a doc comment

     */
    public function field(
        string $field,
        float $factor,
        string $modifier = 'none',

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

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

        ?\Closure $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

    ) : FunctionScore {

Opening brace should be on a new line

        $this->query->addFieldValueFactorFunction(
            $field,
            $factor,
            $modifier,
            $this->buildQueryFromSearchClosure($search)
        );
        
        return $this;
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end field()

    
    /**
     * Decay
     *
     * @param string $type

Missing parameter comment

Expected 8 spaces after parameter type; 1 found

Tag value indented incorrectly; expected 2 spaces but found 1

     * @param string $field

Missing parameter comment

Expected 8 spaces after parameter type; 1 found

Tag value indented incorrectly; expected 2 spaces but found 1

     * @param array $function

Missing parameter comment

Expected 9 spaces after parameter type; 1 found

Tag value indented incorrectly; expected 2 spaces but found 1

     * @param array $options

Missing parameter comment

Expected 9 spaces after parameter type; 1 found

Tag value indented incorrectly; expected 2 spaces but found 1

     * @param \Closure|null $search

Missing parameter comment

Tag value indented incorrectly; expected 2 spaces but found 1

     * @param int|null $weight

Missing parameter comment

Expected 6 spaces after parameter type; 1 found

Expected "integer|null" but found "int|null" for parameter type

Tag value indented incorrectly; expected 2 spaces but found 1

     * @return FunctionScore

Tag cannot be grouped with parameter tags in a doc comment

     */
    public function decay(
        string $type,
        string $field,
        array $function,
        array $options = [],

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

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

Short array syntax is not allowed

        ?\Closure $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

        int $weight = null

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

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

    ) : FunctionScore {

Opening brace should be on a new line

        $this->query->addDecayFunction(
            $type,
            $field,
            $function,
            $options,
            $this->buildQueryFromSearchClosure($search),
            $weight
        );
        
        return $this;
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end decay()

    
    /**
     * Weight
     *
     * @param float $weight

Missing parameter comment

Expected 9 spaces after parameter type; 1 found

Tag value indented incorrectly; expected 2 spaces but found 1

     * @param \Closure|null $search

Missing parameter comment

Tag value indented incorrectly; expected 2 spaces but found 1

     * @return FunctionScore

Tag cannot be grouped with parameter tags in a doc comment

     */
    public function weight(float $weight, ?\Closure $search = null) : FunctionScore

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

    {
        $this->query->addWeightFunction($weight, $this->buildQueryFromSearchClosure($search));
        return $this;
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end weight()

    
    /**
     * Random
     *
     * @param int|null $seed

Missing parameter comment

Expected 6 spaces after parameter type; 1 found

Expected "integer|null" but found "int|null" for parameter type

Tag value indented incorrectly; expected 2 spaces but found 1

     * @param \Closure|null $search

Missing parameter comment

Tag value indented incorrectly; expected 2 spaces but found 1

     * @return FunctionScore

Tag cannot be grouped with parameter tags in a doc comment

     */
    public function random(?int $seed = null, ?\Closure $search = null) : FunctionScore

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

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

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

    {
        $this->query->addRandomFunction($seed, $this->buildQueryFromSearchClosure($search));
        return $this;
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end random()

    
    /**
     * Script
     *
     * @param string $inline

Missing parameter comment

Expected 8 spaces after parameter type; 1 found

Tag value indented incorrectly; expected 2 spaces but found 1

     * @param array $params

Missing parameter comment

Expected 9 spaces after parameter type; 1 found

Tag value indented incorrectly; expected 2 spaces but found 1

     * @param array $options

Missing parameter comment

Expected 9 spaces after parameter type; 1 found

Tag value indented incorrectly; expected 2 spaces but found 1

     * @param \Closure|null $search

Missing parameter comment

Tag value indented incorrectly; expected 2 spaces but found 1

     * @return FunctionScore

Tag cannot be grouped with parameter tags in a doc comment

     */
    public function script(
        string $inline,
        array $params = [],

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

Short array syntax is not allowed

        array $options = [],

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

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

Short array syntax is not allowed

        ?\Closure $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

    ) : FunctionScore {

Opening brace should be on a new line

        $this->query->addScriptScoreFunction(
            $inline,
            $params,
            $options,
            $this->buildQueryFromSearchClosure($search)
        );
        
        return $this;
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end script()

    
    /**
     * Simple
     *
     * @param array $functions

Missing parameter comment

Tag value indented incorrectly; expected 2 spaces but found 1

     * @return FunctionScore

Tag cannot be grouped with parameter tags in a doc comment

     */
    public function simple(array $functions) : FunctionScore
    {
        $this->query->addSimpleFunction($functions);
        return $this;
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end simple()

    
    /**
     * Build query from search closure
     *
     * @param \Closure|null $search

Missing parameter comment

Tag value indented incorrectly; expected 2 spaces but found 1

     * @return BuilderInterface|null

Tag cannot be grouped with parameter tags in a doc comment

     */
    private function buildQueryFromSearchClosure(?\Closure $search) : ?BuilderInterface

Private method name "FunctionScore::buildQueryFromSearchClosure" must be prefixed with an underscore

    {
        $query = null;
    
        if ($search) {
            $searchBuilder = app()->make(Search::class);
            $search($searchBuilder);
        
            $query = $searchBuilder->getQuery();
        }
        
        return $query;
    }

Expected 2 blank lines after function; 0 found

Expected 1 blank line before closing function brace; 0 found

Expected //end buildQueryFromSearchClosure()

}

Expected //end class

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