public function PurgerCommands::purgerListAvailable in Purge 8.3

List available plugin IDs for which purgers can be added.

@usage drush p:purgers-lsa List available plugin IDs for which purgers can be created. @usage drush p:purgers-lsa --format=list Retrieve a simple list of plugin IDs. @usage drush p:purgers-lsa --format=json Export as JSON. @usage drush p:purgers-lsa --format=yaml Export as YAML.

@command p:purger-lsa @aliases pplsa,p-purger-lsa @field-labels plugin_id: Plugin label: Label description: Description

Parameters

array $options: Associative array of options whose values come from Drush.

Return value

array|\Consolidation\OutputFormatters\StructuredData\RowsOfFields Row-based structure of data.

File

modules/purge_drush/src/Commands/PurgerCommands.php, line 157

Class

PurgerCommands

Configure Purge Purgers from the command line.

Namespace

Drupal\purge_drush\Commands

Code

public function purgerListAvailable(array $options = [
  'format' => 'table',
]) {
  $definitions = $this->purgePurgers
    ->getPlugins();
  $available = $this->purgePurgers
    ->getPluginsAvailable();
  $rows = [];
  if ($options['format'] == 'list') {
    foreach ($available as $plugin_id) {
      $rows[] = $plugin_id;
    }
    return $rows;
  }
  else {
    foreach ($available as $plugin_id) {
      $rows[$plugin_id] = [
        'plugin_id' => $plugin_id,
        'label' => (string) $definitions[$plugin_id]['label'],
        'description' => (string) $definitions[$plugin_id]['description'],
      ];
    }
    return new RowsOfFields($rows);
  }
}