App\Containers\Documentation\Tasks\GenerateApiDocJsDocsTask

Complexity

Total Complexity

2

Size/Duplication

Total Lines	28
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	4

Importance

Changes

0

1 Method

Rating	Name	Duplication	Size	Complexity
A	run()	0	18	2

<?php

namespace App\Containers\Documentation\Tasks;

use App\Containers\Documentation\Contracts\ApiTypeInterface;
use App\Port\Task\Abstracts\Task;
use Symfony\Component\Process\Exception\ProcessFailedException;
use Symfony\Component\Process\Process;

/**
 * Class GenerateApiDocJsDocsTask.
 *
 * @author Mahmoud Zalt <mahmoud@zalt.me>
 */
class GenerateApiDocJsDocsTask extends Task
{

    /**
     * @param \App\Containers\Documentation\Contracts\ApiTypeInterface $type
     *
     * @return  mixed
     */
    public function run(ApiTypeInterface $type)
    {
        // the actual command that needs to be executed
        $command = "apidoc -c {$type->getJsonFilePath()} -f {$type->getType()}.php -i app -o {$type->getDocumentationPath()}";

        // execute the command
        ($process = new Process($command))->run();

        if (!$process->isSuccessful()) {
            throw new ProcessFailedException($process);
        }

        // echo the output
        echo $type->getType() . ': ' . $process->getOutput();

        // return the past to that generated documentation
        return $type->getUrl();
    }

}