Mpociot\ApiDoc\Commands\UpdateDocumentation

Complexity

Total Complexity

3

Size/Duplication

Total Lines	52
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes	1
Bugs	0	Features	1

2 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	handle()	0	16	2

<?php

namespace Mpociot\ApiDoc\Commands;

use Illuminate\Console\Command;
use Illuminate\Support\Facades\Route;
use Mpociot\ApiDoc\ApiDocGenerator;
use Mpociot\Documentarian\Documentarian;
use phpDocumentor\Reflection\DocBlock;
use Symfony\Component\Process\Process;

class UpdateDocumentation extends Command
{

    /**
     * The name and signature of the console command.
     *
     * @var string
     */
    protected $signature = 'api:update 
                            {--location=public/docs : The documentation location}
    ';

    /**
     * The console command description.
     *
     * @var string
     */
    protected $description = 'Update and rebuild your API documentation from your markdown file.';

    /**
     * Create a new command instance.
     *
     * @return void

Adding a @return annotation to constructors is generally not recommended as a constructor does not have a meaningful return value.

     */
    public function __construct()
    {
        parent::__construct();
    }

    /**
     * Execute the console command.
     *
     * @return mixed
     */
    public function handle()
    {
        $outputPath = $this->option('location');

        $documentarian = new Documentarian();

        if (!is_dir($outputPath)) {
            $this->error('There is no generated documentation available at '.$outputPath.'.');
            return false;
        }
        $this->info('Updating API HTML code');

        $documentarian->generate($outputPath);

        $this->info('Wrote HTML documentation to: ' . $outputPath . '/public/index.html');
    }

}