Triadev\Leopard\Console\Commands\Index\Sync

Complexity

Total Complexity

7

Size/Duplication

Total Lines	69
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	getChunkSize()	0	3	1
A	getModelsToSync()	0	14	2
A	handle()	0	18	4

<?php

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

namespace Triadev\Leopard\Console\Commands\Index;

Missing file doc comment

use Illuminate\Console\Command;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Support\Collection;
use Triadev\Leopard\Business\Helper\IsModelSearchable;
use Triadev\Leopard\Facade\Leopard;
use Triadev\Leopard\Searchable;

class Sync extends Command

Missing class doc comment

{

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

    use IsModelSearchable;
    
    /**
     * The console command name.
     *
     * @var string
     */
    protected $signature = 'triadev:index:sync {--index=}';

Protected member variable "signature" must contain a leading underscore

    
    /**
     * The console command description.
     *
     * @var string
     */
    protected $description = 'Sync the elasticsearch index with persist data.';

Protected member variable "description" must contain a leading underscore

    
    /**
     * Execute the console command.
     */

Missing @return tag in function comment

    public function handle()

Expected 2 blank lines before function; 1 found

    {
        $index = $this->option('index') ?: Leopard::getEsDefaultIndex();

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

Inline IF statements are not allowed

        
        if (!Leopard::getEsClient()->indices()->exists(['index' => $index])) {

There must be a single space after a NOT operator; 0 found

            $this->error(sprintf("The index does not exist: %s", $index));

The string literal The index does not exist: %s does not require double quotes, as per coding-style, please use single quotes.

            return;
        }
        
        $chunkSize = $this->getChunkSize();
        
        foreach ($this->getModelsToSync($index) as $modelClass => $model) {
            $this->line(sprintf("Sync index with model: %s", $modelClass));

The string literal Sync index with model: %s does not require double quotes, as per coding-style, please use single quotes.

            
            $model::chunk($chunkSize, function ($models) {

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

                /** @var Collection $models */

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

                Leopard::repository()->bulkSave($models);
                $this->line(sprintf("Indexing a chunk of %s documents ...", count($models)));

The string literal Indexing a chunk of %s documents ... does not require double quotes, as per coding-style, please use single quotes.

            });

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 handle()

    
    /**

Missing short description in doc comment

     * @return int

Expected "integer" but found "int" for function return type

     */
    private function getChunkSize() : int

Private method name "Sync::getChunkSize" must be prefixed with an underscore

    {
        return config('leopard.sync.chunkSize');
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end getChunkSize()

    
    /**

Missing short description in doc comment

     * @param string $index

Missing parameter comment

     * @return Model|Searchable[]
     */
    private function getModelsToSync(string $index) : array

Private method name "Sync::getModelsToSync" must be prefixed with an underscore

    {
        $models = [];
    
        foreach (config(sprintf("leopard.sync.models.%s", $index), []) as $modelClass) {

The string literal leopard.sync.models.%s does not require double quotes, as per coding-style, please use single quotes.

            /** @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

            $model = new $modelClass();
    
            $this->isModelSearchable($model);

It seems like $model can also be of type Triadev\Leopard\Searchable; however, parameter $model of Triadev\Leopard\Console\Commands\Index\Sync::isModelSearchable() does only seem to accept Illuminate\Database\Eloquent\Model, maybe add an additional type check?

            
            $models[$modelClass] = $model;
        }
        
        return $models;
    }

Expected 2 blank lines after function; 0 found

Expected 1 blank line before closing function brace; 0 found

Expected //end getModelsToSync()

}

Expected //end class

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