Triadev\Leopard\Searchable

Complexity

Total Complexity

21

Size/Duplication

Total Lines	138
Duplicated Lines	0 %

Test Coverage

Coverage

86.67%

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	repository()	0	3	1
A	shouldSyncDocument()	0	7	2
A	getDocumentData()	0	11	4
A	getDocumentType()	0	7	2
A	bootSearchable()	0	13	3
A	__call()	0	11	3
A	getDocumentIndex()	0	7	2
A	buildDocumentFromArray()	0	19	4

<?php

This file is missing a doc comment.

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

namespace Triadev\Leopard;

Missing file doc comment

use Carbon\Carbon;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Support\Collection;
use Triadev\Leopard\Contract\ElasticsearchManagerContract;
use Triadev\Leopard\Contract\Repository\ElasticsearchRepositoryContract;
use Triadev\Leopard\Facade\Leopard;

/**
 * Trait Searchable
 * @package Triadev\Leopard

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

 *
 * @property string $documentIndex
 * @property string $documentType
 * @property bool $syncDocument
 * @property array $searchable
 *
 * @method static ElasticsearchManagerContract search()
 * @methdo static ElasticsearchManagerContract suggest()
 * @method array buildDocument()

Tags must be grouped together in a doc comment

 * @method array toArray()
 * @method string getTable()
 */

Missing @category tag in class comment

Missing @author tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

trait Searchable
{

Opening brace should be on the same line as the declaration for trait Searchable

    /** @var bool */

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

    public $isDocument = false;

Expected 1 blank line before member var; 0 found

    
    /** @var float|null */

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

    public $documentScore;
    
    /** @var int|null */

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

    public $documentVersion;
    
    /**
     * Searchable boot model.
     */

Missing @return tag in function comment

    public static function bootSearchable()

Expected 2 blank lines before function; 1 found

    {
        static::saved(function (Model $model) {

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

            /** @var Model|Searchable $model */

Inline doc block comments are not allowed; use "/* Comment */" or "// Comment" instead

Block comments must be started with /*

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

            if ($model->shouldSyncDocument()) {
                $model->repository()->save(/** @scrutinizer ignore-type */$model);

Inline doc block comments are not allowed; use "/* Comment */" or "// Comment" instead

Block comments must be started with /*

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

            }
        });

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

    
        static::deleted(function (Model $model) {

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

            /** @var Model|Searchable $model */

Inline doc block comments are not allowed; use "/* Comment */" or "// Comment" instead

Block comments must be started with /*

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

            if ($model->shouldSyncDocument()) {
                $model->repository()->delete(/** @scrutinizer ignore-type */$model);

The call to Illuminate\Database\Eloquent\Builder::delete() has too many arguments starting with $model.

Inline doc block comments are not allowed; use "/* Comment */" or "// Comment" instead

Block comments must be started with /*

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

            }
        });

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

    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end bootSearchable()

    
    /**
     * Repository
     *
     * @return ElasticsearchRepositoryContract
     */
    public function repository() : ElasticsearchRepositoryContract
    {
        return app(ElasticsearchRepositoryContract::class);
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end repository()

    
    /**
     * Get document index
     *
     * @return string|null
     */
    public function getDocumentIndex(): ?string
    {
        if (property_exists($this, 'documentIndex')) {
            return $this->documentIndex;
        }
        
        return null;
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end getDocumentIndex()

    
    /**
     * Get document type
     *
     * @return string
     */
    public function getDocumentType(): string
    {
        if (property_exists($this, 'documentType')) {
            return (string)$this->documentType;
        }
        
        return (string)$this->getTable();
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end getDocumentType()

    
    /**
     * Should sync document
     *
     * @return bool

Expected "boolean" but found "bool" for function return type

     */
    public function shouldSyncDocument() : bool
    {
        if (property_exists($this, 'syncDocument')) {
            return (bool)$this->syncDocument;
        }
        
        return true;
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end shouldSyncDocument()

    
    /**
     * Get document data
     *
     * @return array
     */
    public function getDocumentData() : array
    {
        if (method_exists($this, 'buildDocument')) {
            return $this->buildDocument();
        }
        
        if (property_exists($this, 'searchable') && is_array($this->searchable)) {
            return $this->buildDocumentFromArray($this->searchable);
        }
        
        return $this->toArray();
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end getDocumentData()

    
    private function buildDocumentFromArray(array $searchable)

Private method name "Searchable::buildDocumentFromArray" must be prefixed with an underscore

Missing function doc comment

    {
        $document = [];

Short array syntax is not allowed

        
        foreach ($searchable as $value) {
            $result = $this->$value;
            
            if ($result instanceof Collection) {
                $result = $result->toArray();
            } elseif ($result instanceof Carbon) {

Usage of ELSEIF not allowed; use ELSE IF instead

                $result = $result->toDateTimeString();
            } else {
                $result = $this->$value;
            }
            
            $document[$value] = $result;
        }
        
        return $document;
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end buildDocumentFromArray()

    
    /**

Missing short description in doc comment

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

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

     * @param $name

Missing parameter name

     * @param $arguments

Missing parameter name

     * @return mixed
     */
    public function __call($name, $arguments)

Type hint "name" missing for

Type hint "arguments" missing for

    {
        if ($name == 'search') {

Operator == prohibited; use === instead

            return Leopard::search()->model($this);

$this of type Triadev\Leopard\Searchable is incompatible with the type Illuminate\Database\Eloquent\Model expected by parameter $model of Triadev\Leopard\Business\Dsl\Search::model().

        }
        
        if ($name == 'suggest') {

Operator == prohibited; use === instead

            return Leopard::suggest();
        }
        
        return parent::__call($name, $arguments);
    }

Expected 2 blank lines after function; 0 found

Expected 1 blank line before closing function brace; 0 found

Expected //end __call()

}

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