Robo\Common\VerbosityThresholdTrait

Complexity

Total Complexity

9

Size/Duplication

Total Lines	80
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	setVerbosityThreshold()	0	5	1
A	verbosityThreshold()	0	4	1
A	setOutputAdapter()	0	4	1
A	outputAdapter()	0	4	1
A	hasOutputAdapter()	0	4	1
A	verbosityMeetsThreshold()	0	7	2
A	writeMessage()	0	7	2

<?php

namespace Robo\Common;

use Robo\Robo;
use Robo\TaskInfo;
use Robo\Contract\OutputAdapterInterface;
use Robo\Contract\VerbosityThresholdInterface;
use Consolidation\Log\ConsoleLogLevel;
use Psr\Log\LoggerAwareTrait;
use Psr\Log\LogLevel;
use Robo\Contract\ProgressIndicatorAwareInterface;
use Symfony\Component\Console\Output\OutputInterface;

/**
 * Task input/output methods.  TaskIO is 'used' in BaseTask, so any
 * task that extends this class has access to all of the methods here.
 * printTaskInfo, printTaskSuccess, and printTaskError are the three
 * primary output methods that tasks are encouraged to use.  Tasks should
 * avoid using the IO trait output methods.
 */
trait VerbosityThresholdTrait
{
    /**
     * @var \Robo\Contract\OutputAdapterInterface
     */
    protected $outputAdapter;

    /**
     * @var int
     */
    protected $verbosityThreshold = 0;

    /**
     * Required verbosity level before any TaskIO output will be produced.
     * e.g. OutputInterface::VERBOSITY_VERBOSE
     *
     * @param int $verbosityThreshold
     *
     * @return $this
     */
    public function setVerbosityThreshold($verbosityThreshold)
    {
        $this->verbosityThreshold = $verbosityThreshold;
        return $this;
    }

    /**
     * @return int
     */
    public function verbosityThreshold()
    {
        return $this->verbosityThreshold;
    }

    public function setOutputAdapter(OutputAdapterInterface $outputAdapter)
    {
        $this->outputAdapter = $outputAdapter;
    }

    /**
     * @return \Robo\Contract\OutputAdapterInterface
     */
    public function outputAdapter()
    {
        return $this->outputAdapter;
    }

    /**
     * @return bool
     */
    public function hasOutputAdapter()
    {
        return isset($this->outputAdapter);
    }

    /**
     * @return bool
     */
    public function verbosityMeetsThreshold()
    {
        if ($this->hasOutputAdapter()) {
            return $this->outputAdapter()->verbosityMeetsThreshold($this->verbosityThreshold());
        }
        return true;
    }

    /**
     * Print a message if the selected verbosity level is over this task's
     * verbosity threshold.
     *
     * @param string $message
     */
    public function writeMessage($message)
    {
        if (!$this->verbosityMeetsThreshold()) {
            return;
        }
        $this->outputAdapter()->writeMessage($message);
    }
}