TypedDataCommands.php in Typed Data API enhancements 8

Namespace

Drupal\typed_data\Commands

File

src/Commands/TypedDataCommands.php

<?php

namespace Drupal\typed_data\Commands;

use Drush\Commands\DrushCommands;

/**
 * Drush 9+ commands for the Typed Data API Enhancements module.
 */
class TypedDataCommands extends DrushCommands {

  /**
   * Show a list of available entities.
   *
   * @command typed-data:entities
   * @aliases el,entity-list
   */
  public function listEntities() {

    // Dependency injection deliberately not used. So ignore the phpcs message.
    // @see https://www.drupal.org/project/typed_data/issues/3164489
    // @phpcs:ignore DrupalPractice.Objects.GlobalDrupal.GlobalDrupal
    $entities = array_keys(\Drupal::entityTypeManager()
      ->getDefinitions());
    $unique = array_unique($entities);
    sort($unique);
    $this
      ->output()
      ->writeln(dt('Entity machine names:'));
    $this
      ->output()
      ->writeln('  ' . implode(PHP_EOL . '  ', $unique) . PHP_EOL);
  }

  /**
   * Show a list of available contexts.
   *
   * @command typed-data:contexts
   * @aliases cl,context-list
   */
  public function listContexts() {

    // @phpcs:ignore DrupalPractice.Objects.GlobalDrupal.GlobalDrupal
    $contexts = array_keys(\Drupal::service('context.repository')
      ->getAvailableContexts());
    $unique = array_unique($contexts);
    sort($unique);
    $this
      ->output()
      ->writeln(dt('Global context variables:'));
    $this
      ->output()
      ->writeln('  ' . implode(PHP_EOL . '  ', $unique) . PHP_EOL);
  }

  /**
   * Show a list of available Typed Data datatypes.
   *
   * @command typed-data:datatypes
   * @aliases tl,datatype-list
   */
  public function listDataTypes() {

    // @phpcs:ignore DrupalPractice.Objects.GlobalDrupal.GlobalDrupal
    $definitions = \Drupal::service('typed_data_manager')
      ->getDefinitions();
    $datatypes = [];
    foreach ($definitions as $plugin) {

      // $datatypes[] = $plugin['class'];
      $datatypes[] = $plugin['id'];
    }
    $unique = array_unique($datatypes);
    sort($unique);
    $this
      ->output()
      ->writeln(dt('Available TypedData data types:'));
    $this
      ->output()
      ->writeln('  ' . implode(PHP_EOL . '  ', $unique) . PHP_EOL);
  }

  /**
   * Show a list of available TypedDataFilter plugins.
   *
   * @command typed-data:datafilters
   * @aliases fl,datafilter-list
   */
  public function listDataFilters() {
    $this
      ->formatOutput('plugin.manager.typed_data_filter', 'Available TypedDataFilter plugins:', FALSE);
  }

  /**
   * Show a list of available TypedDataFormWidget plugins.
   *
   * @command typed-data:formwidgets
   * @aliases wl,formwidget-list
   */
  public function listFormWidgets() {
    $this
      ->formatOutput('plugin.manager.typed_data_form_widget', 'Available TypedDataFormWidget plugins:', FALSE);
  }

  /**
   * Helper function to format command output.
   */
  protected function formatOutput($plugin_manager_service, $title, $categories = TRUE, $short = FALSE) {

    // @phpcs:ignore DrupalPractice.Objects.GlobalDrupal.GlobalDrupal
    $definitions = \Drupal::service($plugin_manager_service)
      ->getDefinitions();
    $plugins = [];
    foreach ($definitions as $plugin) {
      if ($categories) {
        if ($short) {
          $plugins[(string) $plugin['category']][] = $plugin['id'];
        }
        else {
          $plugins[(string) $plugin['category']][] = $plugin['label'] . '   (' . $plugin['id'] . ')';
        }
      }
      else {
        if ($short) {
          $plugins[] = $plugin['id'];
        }
        else {
          $plugins[] = $plugin['label'] . '   (' . $plugin['id'] . ')';
        }
      }
    }
    $this
      ->output()
      ->writeln(dt($title));
    if ($categories) {
      ksort($plugins);
      foreach ($plugins as $category => $plugin_list) {
        $this
          ->output()
          ->writeln('  ' . $category);
        sort($plugin_list);
        $this
          ->output()
          ->writeln('    ' . implode(PHP_EOL . '    ', $plugin_list));
        $this
          ->output()
          ->writeln('');
      }
    }
    else {
      $unique = array_unique($plugins);
      sort($unique);
      $this
        ->output()
        ->writeln('  ' . implode(PHP_EOL . '  ', $unique) . PHP_EOL);
    }
  }

}

Classes

Name	Description
TypedDataCommands	Drush 9+ commands for the Typed Data API Enhancements module.