BristolSU\ControlDB\Export\ExportControlCommand

Complexity

Total Complexity

6

Size/Duplication

Total Lines	54
Duplicated Lines	0 %

Test Coverage

Coverage

93.33%

Importance

Changes	1
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	exportData()	0	18	5
A	handle()	0	4	1

<?php

Missing file doc comment

namespace BristolSU\ControlDB\Export;

use BristolSU\ControlDB\Contracts\Repositories\Group;
use BristolSU\ControlDB\Contracts\Repositories\Position;
use BristolSU\ControlDB\Contracts\Repositories\Role;
use BristolSU\ControlDB\Contracts\Repositories\User;
use BristolSU\ControlDB\Export\Formatter\Role\SortByGroupName;

The type BristolSU\ControlDB\Export\Formatter\Role\SortByGroupName was not found. Maybe you did not declare it correctly or list all dependencies?

use BristolSU\ControlDB\Export\Formatter\Shared\SortByColumn;
use Illuminate\Console\Command;
use Symfony\Component\Console\Exception\InvalidArgumentException;

/**
 * Seed the database
 */

Missing @category tag in class comment

Missing @package tag in class comment

Missing @author tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

class ExportControlCommand extends Command
{
    /**
     * Signature for the command
     * 
     * @var string 
     */
    protected $signature = 'control:export
                            {type : The type of resource to export}
                            {--exporter= : The name of the exporter to use}';

    /**
     * Name for the commmand
     * 
     * @var string 
     */
    protected $name = 'Export Control';

    /**
     * Description of the command
     * 
     * @var string 
     */
    protected $description = 'Export control to an external service';

    /**
     * Handle the command execution
     * 
     * Seed the database with fake data.
     */

Missing @return tag in function comment

    public function handle()
    {
        Exporter::driver($this->option('exporter'))->export($this->exportData());

The method driver() does not exist on BristolSU\ControlDB\Export\Exporter. Since you implemented __callStatic, consider adding a @method annotation.

        $this->info('Export complete');
    }

    private function exportData()

Private method name "ExportControlCommand::exportData" must be prefixed with an underscore

Missing doc comment for function exportData()

    {
        switch($this->argument('type')) {
            case 'user': 

Line indented incorrectly; expected 8 spaces, found 12

                return app(User::class)->all();
                break;

break is not strictly necessary here and could be removed.

            case 'group':

Line indented incorrectly; expected 8 spaces, found 12

                return app(Group::class)->all();
                break;
            case 'role':

Line indented incorrectly; expected 8 spaces, found 12

                return app(Role::class)->all();
                break;
            case 'position':

Line indented incorrectly; expected 8 spaces, found 12

                return app(Position::class)->all();
                break;
            default:

Line indented incorrectly; expected 8 spaces, found 12

                throw new InvalidArgumentException(sprintf('The type option %s is not allowed.', $this->argument('type')));

It seems like $this->argument('type') can also be of type string[]; however, parameter $args of sprintf() does only seem to accept string, maybe add an additional type check?

                break;
        }
    }
}