class SiteAuditCommands in Site Audit 8.3

SiteAudit Drush commandfile.

Hierarchy

class \Drupal\site_audit\Commands\SiteAuditCommands extends \Drush\Commands\DrushCommands implements \Robo\Contract\IOAwareInterface, \Psr\Log\LoggerAwareInterface, \Robo\Contract\ConfigAwareInterface, \Consolidation\AnnotatedCommand\Events\CustomEventAwareInterface, \Drush\Boot\AutoloaderAwareInterface uses \Consolidation\AnnotatedCommand\Events\CustomEventAwareTrait, \Drush\Boot\AutoloaderAwareTrait, StringTranslationTrait

Expanded class hierarchy of SiteAuditCommands

1 string reference to 'SiteAuditCommands'

drush.services.yml in ./drush.services.yml: drush.services.yml

1 service uses SiteAuditCommands

site_audit.commands in ./drush.services.yml: \Drupal\site_audit\Commands\SiteAuditCommands

File

src/Commands/SiteAuditCommands.php, line 26

Namespace

Drupal\site_audit\Commands

View source

class SiteAuditCommands extends DrushCommands implements IOAwareInterface, LoggerAwareInterface, ConfigAwareInterface, CustomEventAwareInterface, AutoloaderAwareInterface {
  use CustomEventAwareTrait;
  use AutoloaderAwareTrait;
  use StringTranslationTrait;

  /**
   * The Site Audit Check manager.
   *
   * @var \Drupal\site_audit\Plugin\SiteAuditCheckManager
   */
  protected $auditCheckManager;

  /**
   * The Site Audit Report manager.
   *
   * @var \Drupal\site_audit\Plugin\SiteAuditReportManager
   */
  protected $auditReportManager;

  /**
   * Constructs the SiteAuditCommands.
   *
   * @param \Drupal\site_audit\Plugin\SiteAuditCheckManager $auditCheckManager
   *   The Site Audit Check manager.
   * @param \Drupal\site_audit\Plugin\SiteAuditReportManager $auditReportManager
   *   The Site Audit Report manager.
   */
  public function __construct(SiteAuditCheckManager $auditCheckManager, SiteAuditReportManager $auditReportManager) {
    parent::__construct();
    $this->auditCheckManager = $auditCheckManager;
    $this->auditReportManager = $auditReportManager;
  }

  /**
   * Run a Site Audit report.
   *
   * @param $report
   *   The particular report to run. Omit this argument to choose from available reports.
   *
   * @option skip
   *   List of available reports.
   * @option format
   *   Format you which the report is to be in (html, text, json, markdown)
   * @option detail
   *   Show details when no issues found for the check.
   * @option bootstrap
   *   Wrap the report in HTML with Bootstrap derived styles. Forces --format=html
   * @usage site_audit:audit
   *   Run all Site Audit reports
   *
   * @command site_audit:audit
   * @aliases audit
   *
   * @usage audit watchdog
   *   only run the watchdog report
   * @usage audit --skip=block,status
   *  skip the block and status reports
   */
  public function audit($report, $options = [
    'skip' => 'none',
    'format' => 'text',
    'detail' => FALSE,
    'bootstrap' => FALSE,
  ]) {
    if ($options['bootstrap']) {

      // Bootstrap implies html.
      $options['format'] = 'html';
    }
    $boot_manager = Drush::bootstrapManager();
    $output = $this
      ->output();
    $out = '';
    $reportDefinitions = $this->auditReportManager
      ->getDefinitions();
    $reports = [];
    if ($report == 'all') {

      // Run all reports unless it is explicitly skipped.
      $skipped = explode(',', $options['skip']);
      foreach ($reportDefinitions as $report) {
        $isSkipped = array_search($report['id'], $skipped);
        if ($isSkipped === FALSE) {
          $reports[] = $this->auditReportManager
            ->createInstance($report['id'], $options);
        }
      }
    }
    elseif (!empty($report)) {
      $reports[] = $this->auditReportManager
        ->createInstance($report, $options);
    }
    switch ($options['format']) {
      case 'html':
        $renderer = new Html($reports, $this->logger, $options, $output);
        $out .= $renderer
          ->render(TRUE);
        break;
      case 'json':
        foreach ($reports as $report) {
          $renderer = new Json($report, $this->logger, $options, $output);
          $out .= $renderer
            ->render(TRUE);
        }
        break;
      case 'markdown':
        foreach ($reports as $report) {
          $renderer = new Markdown($report, $this->logger, $options, $output);
          $out .= $renderer
            ->render(TRUE);
        }
        break;
      case 'text':
      default:
        foreach ($reports as $report) {
          $renderer = new Console($report, $this->logger, $options, $output);

          // The Console::renderer() doesn't return anything, it print directly to the console.
          $renderer
            ->render(TRUE);
        }
        break;
    }
    return $out;
  }

  /**
   * Run All Site Audit reports.
   *
   * @option format
   *   Format you which the report is to be in (html, text, json, markdown)
   * @option detail
   *   Show details when no issues found for the check.
   * @option bootstrap
   *   Wrap the report in HTML with Bootstrap derived styles. Forces --format=html
   * @usage site_audit:audit-all
   *   Run all Site Audit reports
   *
   * @command site_audit:all
   * @aliases audit-all
   * @aliases aa
   *
   * @usage audit-all
   *   run all reports
   * @usage audit-all --skip=block,status
   *  skip the block and status reports
   */
  public function audit_all($options = [
    'skip' => 'none',
    'format' => 'text',
    'detail' => FALSE,
    'bootstrap' => FALSE,
  ]) {
    return $this
      ->audit('all', $options);
  }

  /**
   * Take Drupal\Core\StringTranslation\TranslatableMarkup and return the string.
   *
   * @param $message
   * @param array $context
   *
   * @return string
   */
  public function interpolate($message, array $context = []) {
    if (get_class($message) == 'Drupal\\Core\\StringTranslation\\TranslatableMarkup') {
      return $message
        ->render();
    }
    return $message;
  }

  /**
   * @hook interact site_audit:audit
   * @param $input
   * @param $output
   * @throws \Drush\Exceptions\UserAbortException
   */
  public function interactSiteAudit($input, $output) {
    $boot_manager = Drush::bootstrapManager();
    if (empty($input
      ->getArgument('report'))) {
      $reports = $this
        ->getReports($boot_manager
        ->hasBootstrapped(DRUSH_BOOTSTRAP_DRUPAL_FULL));
      $choices = [
        'all' => $this
          ->interpolate($this
          ->t('All')),
      ];
      foreach ($reports as $report) {
        $choices[$report['id']] = $this
          ->interpolate($report['name']);
      }
      $choice = $this
        ->io()
        ->choice($this
        ->t("Choose a report to run"), $choices, 'all');
      $input
        ->setArgument('report', $choice);
    }
  }

  /**
   * Get a list of all the report definitions
   */
  public function getReports($include_bootstrapped_types = FALSE) {
    $reportDefinitions = $this->auditReportManager
      ->getDefinitions();
    return $reportDefinitions;
  }

  /**
   * List of all available reports.
   *
   * @field-labels
   *   report_id: Report ID
   *   report_name: Report Name
   *   report_description : Report Description
   *   check_id: Check ID
   *   check_name: Check Name
   *   check_description: Check Description
   * @default-fields report_id,report_name,check_name,check_description
   *
   * @command site_audit:list
   * @aliases audit-list
   *
   * @return \Consolidation\OutputFormatters\StructuredData\RowsOfFields
   */
  public function list() {
    $reportDefinitions = $this->auditReportManager
      ->getDefinitions();
    $checkDefinitions = $this->auditCheckManager
      ->getDefinitions();
    $rows = [];
    $report_id = '';
    foreach ($reportDefinitions as $report) {
      if ($report_id != $report['id'] && !empty($report_id)) {
        $rows[] = [];
      }
      $thisReport = $this->auditReportManager
        ->createInstance($report['id']);
      $checks = $thisReport
        ->getChecksList();
      foreach ($checks as $check) {
        $rows[] = [
          'report_id' => $report_id == $report['id'] ? '' : $report['id'],
          'report_name' => $report_id == $report['id'] ? '' : $report['name'],
          'report_description' => $report_id == $report['id'] ? '' : $report['description'],
          'check_id' => $checkDefinitions[$check]['id'],
          'check_name' => $checkDefinitions[$check]['name'],
          'check_description' => $checkDefinitions[$check]['description'],
        ];
        $report_id = $report['id'];
      }
    }
    return new RowsOfFields($rows);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
SiteAuditCommands::$auditCheckManager	protected	property	The Site Audit Check manager.
SiteAuditCommands::$auditReportManager	protected	property	The Site Audit Report manager.
SiteAuditCommands::audit	public	function	Run a Site Audit report.
SiteAuditCommands::audit_all	public	function	Run All Site Audit reports.
SiteAuditCommands::getReports	public	function	Get a list of all the report definitions
SiteAuditCommands::interactSiteAudit	public	function	@hook interact site_audit:audit
SiteAuditCommands::interpolate	public	function	Take Drupal\Core\StringTranslation\TranslatableMarkup and return the string.
SiteAuditCommands::list	public	function	List of all available reports.
SiteAuditCommands::__construct	public	function	Constructs the SiteAuditCommands.
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 SiteAuditCommands in Site Audit 8.3

Hierarchy

File

Namespace

Members

API Navigation