class Console in Site Audit 8.3

Hierarchy

class \Drupal\site_audit\Renderer uses StringTranslationTrait
- class \Drupal\site_audit\Renderer\Console

Expanded class hierarchy of Console

1 file declares its use of Console

SiteAuditCommands.php in src/Commands/SiteAuditCommands.php

File

src/Renderer/Console.php, line 19

Namespace

Drupal\site_audit\Renderer

View source

class Console extends Renderer {
  public $output;
  public $formatter;

  /**
   *
   */
  public function __construct($report, $logger, $options, $output) {
    parent::__construct($report, $logger, $options, $output);
    $this->output = $output;
    $this->formatter = new FormatterHelper();
  }

  /**
   *
   */
  public function getLogLevel($score) {
    switch ($score) {
      case SiteAuditCheckBase::AUDIT_CHECK_SCORE_PASS:
        return LogLevel::OK;
      case SiteAuditCheckBase::AUDIT_CHECK_SCORE_WARN:
        return LogLevel::WARNING;
      case SiteAuditCheckBase::AUDIT_CHECK_SCORE_INFO:
        return 'NOTE';
      default:
        return 'ERROR';
    }
  }

  /**
   *
   */
  public function getScoreSymfonyStyle($score) {
    switch ($score) {
      case SiteAuditCheckBase::AUDIT_CHECK_SCORE_PASS:
        return 'score-pass';
      case SiteAuditCheckBase::AUDIT_CHECK_SCORE_INFO:
        return 'score-info';
      case SiteAuditCheckBase::AUDIT_CHECK_SCORE_WARN:
      default:
        return 'score-warn';
    }
  }

  /**
   * Get the SymfonyStyle method associated with a percentage.
   *
   * @return string
   *   Symfony\Component\Console\Style method.
   */
  public function getSymphonyStyle($percent) {
    if ($percent > 80) {
      return 'success';
    }
    if ($percent > 65) {
      return 'warning';
    }
    if ($percent >= 0) {
      return 'error';
    }
    return 'note';
  }

  /**
   * Take text and center it horizontally in the console.
   */
  public function centerText(string $text) {
    $width = (new Terminal())
      ->getWidth();
    $strlen = $this->formatter
      ->strlenWithoutDecoration($this->output
      ->getFormatter(), $text);
    $spaceCount = ($width - $strlen) / 2;
    for ($i = 0; $i < $spaceCount; $i++) {
      $text = ' ' . $text;
    }
    $this->output
      ->writeln($text);
  }

  /**
   * Create a horizontal rule across the console.
   */
  public function horizontalRule() {
    $width = (new Terminal())
      ->getWidth();
    $line = '';
    for ($i = 0; $i < $width; $i++) {
      $line .= '-';
    }
    $this->output
      ->writeln('<info>' . $line . '</>');
  }

  /**
   * Take Drupal\Core\StringTranslation\TranslatableMarkup and return the string.
   */
  public function interpolate(TranslatableMarkup $message, array $context = []) {
    return StringUtils::interpolate($message, $context);
  }

  /**
   *
   */
  public function render($detail = FALSE) {
    $outputStyle = new OutputFormatterStyle('black', 'white');
    $this->output
      ->getFormatter()
      ->setStyle('report', $outputStyle);
    $outputStyle = new OutputFormatterStyle('black', 'cyan');
    $this->output
      ->getFormatter()
      ->setStyle('check', $outputStyle);
    $outputStyle = new OutputFormatterStyle('cyan', 'black');
    $this->output
      ->getFormatter()
      ->setStyle('action', $outputStyle);
    $outputStyle = new OutputFormatterStyle('green', 'black');
    $this->output
      ->getFormatter()
      ->setStyle('success', $outputStyle);
    $outputStyle = new OutputFormatterStyle('red', 'black');
    $this->output
      ->getFormatter()
      ->setStyle('error', $outputStyle);
    $outputStyle = new OutputFormatterStyle('yellow', 'black');
    $this->output
      ->getFormatter()
      ->setStyle('warning', $outputStyle);
    $outputStyle = new OutputFormatterStyle('cyan', 'black');
    $this->output
      ->getFormatter()
      ->setStyle('note', $outputStyle);
    $outputStyle = new OutputFormatterStyle('black', 'green');
    $this->output
      ->getFormatter()
      ->setStyle('score-pass', $outputStyle);
    $outputStyle = new OutputFormatterStyle('white', 'red');
    $this->output
      ->getFormatter()
      ->setStyle('score-warn', $outputStyle);
    $outputStyle = new OutputFormatterStyle('yellow', 'black');
    $this->output
      ->getFormatter()
      ->setStyle('score-info', $outputStyle);
    $reportText = '';
    $percent = $this->report
      ->getPercent();
    $style = $this
      ->getSymphonyStyle($percent);

    // Add the report header.
    $this
      ->horizontalRule();
    $this
      ->centerText('<info>' . $this
      ->interpolate($this
      ->t('Report: ')) . $this
      ->interpolate($this->report
      ->getLabel()) . '</> - <' . $style . '>' . $percent . '%</>');
    $this
      ->horizontalRule();

    // No action required.
    if ($percent == 100) {
      $this
        ->centerText($this
        ->interpolate($this
        ->t('<success>No action required.</>')));
    }

    // Information or a problem.
    if ($detail || $this->report
      ->getPercent() != 100) {
      foreach ($this->report
        ->getCheckObjects() as $check) {
        $label = $this->report
          ->getLabel() . ' - ' . $check
          ->getLabel();
        $score = $check
          ->getScore();
        if ($detail && $score == SiteAuditCheckBase::AUDIT_CHECK_SCORE_INFO || $score < SiteAuditCheckBase::AUDIT_CHECK_SCORE_PASS) {

          // Heading.
          $this->output
            ->writeln($this->formatter
            ->formatSection($label, $check
            ->getDescription()));

          // Result.
          $result = $check
            ->getResult();
          $this->output
            ->writeln($this->formatter
            ->formatSection($label, $this
            ->interpolate($this
            ->t('Result: <@symfony-style>@logLevel</>', [
            '@logLevel' => ucfirst(strtolower($this
              ->getLogLevel($score))),
            '@symfony-style' => $this
              ->getScoreSymfonyStyle($score),
          ]))));
          if (is_array($result)) {
            if ($result['#theme'] && method_exists($this, $result['#theme'])) {
              $this
                ->{$result['#theme']}($result, $label);
            }
            else {
              if ($result['headers'] && $result['rows']) {

                // Theme as a table.
                $table = new Table($this->output);
                $table
                  ->setHeaders($result['headers'])
                  ->setRows($result['rows']);
                $this->output
                  ->writeln($table
                  ->render());
              }
            }
          }
          else {
            $this->output
              ->writeln($this->formatter
              ->formatSection($label, $result));
          }

          // Action.
          $action = $check
            ->renderAction();
          if ($action) {
            if (is_array($action) && $action['#theme'] && method_exists($this, $action['#theme'])) {
              $this->output
                ->writeln($this->formatter
                ->formatSection($label, '<action>' . $this
                ->interpolate($this
                ->t('Action')) . ':</> ' . $action['#title']));
              $this
                ->{$action['#theme']}($action, $label, 'action');
            }
            else {
              $this->output
                ->writeln($this->formatter
                ->formatSection($label, '<action>' . $this
                ->interpolate($this
                ->t('Action')) . ':</> ' . $action));
            }
          }
        }
        $this->output
          ->writeln('');
      }
    }
    $this->output
      ->writeln('<report>' . $reportText . '</>');
  }

  /**
   *
   */
  public function success() {
  }

  /**
   * Theme a table.
   */
  public function table($element, $section = FALSE) {
    if ($section) {
      $this->output
        ->writeln($this->formatter
        ->formatSection($section, $element['#title']));
    }

    // make sure the table headers and rows have no translatable objects
    $headers = $element['#header'] ?: $element['headers'];
    foreach ($headers as &$header) {
      if (is_object($header)) {
        $header = (string) $header;
      }
    }
    $rows = $element['#rows'] ?: [];
    if (!empty($rows)) {
      if (isset($rows['attributes']) && isset($rows['attributes']['class'])) {
        $class = $rows['attributes']['class'];
      }
      else {
        $class = NULL;
      }
      foreach ($rows as &$row) {
        if (isset($row['data'])) {
          $row = $row['data'];
        }
        foreach ($row as &$cell) {
          if (is_object($cell)) {
            $cell = (string) $cell;
          }
        }
      }
    }

    // Theme as a table.
    $table = new Table($this->output);
    $table
      ->setHeaders($headers)
      ->setRows($rows);
    $this->output
      ->writeln($table
      ->render());
  }

  /**
   * Theme an item list.
   */
  public function item_list($element, $section = FALSE, $class = 'note') {
    switch ($element['#list_type']) {
      case 'ol':
        $count = 1;
        foreach ($element['#items'] as $item) {
          $text = '<' . $class . '>' . $count . ':</> ' . $item;
          if ($section) {
            $this->output
              ->writeln($this->formatter
              ->formatSection($section, $text));
          }
          else {
            $this->output
              ->writeln($text);
          }
          $count++;
        }
        break;
      case 'ul':
      default:
        foreach ($element['#items'] as $item) {
          $text = '<' . $class . '>*</> ' . $item;
          if ($section) {
            $this->output
              ->writeln($this->formatter
              ->formatSection($section, $text));
          }
          else {
            $this->output
              ->writeln($text);
          }
          $count++;
        }
        break;
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Console::$formatter	public	property
Console::$output	public	property	Output interface. Overrides Renderer::$output
Console::centerText	public	function	Take text and center it horizontally in the console.
Console::getLogLevel	public	function
Console::getScoreSymfonyStyle	public	function
Console::getSymphonyStyle	public	function	Get the SymfonyStyle method associated with a percentage.
Console::horizontalRule	public	function	Create a horizontal rule across the console.
Console::interpolate	public	function	Take Drupal\Core\StringTranslation\TranslatableMarkup and return the string.
Console::item_list	public	function	Theme an item list.
Console::render	public	function	Overrides Renderer::render
Console::success	public	function
Console::table	public	function	Theme a table.
Console::__construct	public	function	Overrides Renderer::__construct
Renderer::$logger	public	property	The logger we are using for output.
Renderer::$options	public	property	Any options that have been passed in.
Renderer::$report	public	property	The Report to be rendered.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.

You are here

class Console in Site Audit 8.3

Hierarchy

File

Namespace

Members

API Navigation