<?php

/**

* @file

* Contains DrupalCodeBuilder\Task\ReportPluginData.

*/

namespace DrupalCodeBuilder\Task;

use DrupalCodeBuilder\Definition\OptionDefinition;

use MutableTypedData\Definition\OptionSetDefininitionInterface;

use DrupalCodeBuilder\Definition\VariantMappingProviderInterface;

use DrupalCodeBuilder\Task\Report\SectionReportInterface;

/**

* Task handler for reporting on plugin data.

*

* TODO: revisit some of these and clean up names / clean up how many we have.

* Consider merging into a ReportComponentData Task.

*/

class ReportPluginData extends ReportHookDataFolder

implements OptionSetDefininitionInterface, VariantMappingProviderInterface, SectionReportInterface {

use OptionsProviderTrait;

use SectionReportSimpleCountTrait;

/**

* The sanity level this task requires to operate.

*/

protected $sanity_level = 'component_data_processed';

/**

* Cached plugin type data.

*

* @var array

*/

protected $cache;

/**

* {@inheritdoc}

*/

public function getInfo(): array {

return [

'key' => 'plugins',

'label' => 'Plugin types',

'weight' => 5,

];

}

/**

* {@inheritdoc}

*/

public function getDataSummary(): array {

return $this->listPluginNamesOptions();

}

/**

* {@inheritdoc}

*/

public function getVariantMapping(): array {

return $this->getPluginTypesMapping();

}

/**

* Get the list of plugin data.

*

* @param $discovery_type

* (optional) The short name of a discovery class to limit the plugin list

* by. Possible values include:

* - AnnotatedClassDiscovery

* - AttributeDiscoveryWithAnnotations

* - YamlDiscovery

*

* @return

* The processed plugin data.

*

* @see \DrupalCodeBuilder\Task\Collect::gatherPluginTypeInfo()

*

* @todo Split this method into two.

*/

function listPluginData($discovery_type = NULL) {

if ($discovery_type) {

// We may come here several times, so cache a filtered result.

// TODO: look into finer-grained caching higher up.

if (isset($this->cache[$discovery_type])) {

return $this->cache[$discovery_type];

}

}

$plugin_data = $this->environment->getStorage()->retrieve('plugins');

// Filter the plugins if there's a requested discovery type.

if ($discovery_type) {

$plugin_data = array_filter($plugin_data, function($item) use ($discovery_type) {

$discovery_pieces = explode('\\', $item['discovery']);

$discovery_short_name = array_pop($discovery_pieces);

return ($discovery_short_name == $discovery_type);

});

$this->cache[$discovery_type] = $plugin_data;

}

return $plugin_data;

}

/**

* Returns a list of annotated plugin types, keyed by subdirectory.

*

* @return

* A list of all plugin types that use annotation discovery, keyed by the

* subdirectory the plugin files go in, for example, 'Block', 'QueueWorker'.

*/

public function listPluginDataBySubdirectory() {

$plugin_types_data = $this->listPluginData('AnnotatedClassDiscovery');

$plugin_types_data_by_subdirectory = [];

foreach ($plugin_types_data as $plugin_id => $plugin_definition) {

if (!empty($plugin_definition['subdir'])) {

$subdir = substr($plugin_definition['subdir'], strlen('Plugin/'));

$plugin_types_data_by_subdirectory[$subdir] = $plugin_definition;

}

}

return $plugin_types_data_by_subdirectory;

}

/**

* {@inheritdoc}

*/

public function getOptions(): array {

$data = $this->listPluginData();

$options = [];

foreach ($data as $plugin_type_name => $plugin_type_info) {

$url = NULL;

if (isset($plugin_type_info['plugin_interface_filepath'])) {

if (str_starts_with($plugin_type_info['plugin_interface_filepath'], 'core')) {

$url = $this->createClassLikeApiUrl($plugin_type_info['plugin_interface_filepath'], 'interface');

}

}

$options[$plugin_type_name] = OptionDefinition::create(

$plugin_type_name,

$plugin_type_info['type_label'],

api_url: $url ?? NULL,

);

}

return $options;

}

/**

* Get plugin types as a list of options.

*

* @param $discovery_type

* (optional) The short name of a discovery class to limit the plugin list

*

* @return

* An array of plugin types as options suitable for FormAPI.

*/

function listPluginNamesOptions($discovery_type = NULL) {

$data = $this->listPluginData($discovery_type);

$return = [];

foreach ($data as $plugin_type_name => $plugin_type_info) {

$return[$plugin_type_name] = $plugin_type_info['type_label'];

}

return $return;

}

public function getPluginTypesMapping() :array {

$mapping = [];

$data = $this->listPluginData();

// TODO: move all this to analysis!

$types = [

'Drupal\\Core\\Plugin\\Discovery\\AnnotatedClassDiscovery' => 'annotation',

'Drupal\\Core\\Plugin\\Discovery\\AttributeClassDiscovery' => 'attribute',

'Drupal\\Core\\Plugin\\Discovery\\AttributeDiscoveryWithAnnotations' => 'attribute',

'Drupal\\Core\\Plugin\\Discovery\\YamlDiscovery' => 'yaml',

'Drupal\Core\Config\Schema\ConfigSchemaDiscovery' => 'yaml', // ????

];

foreach ($data as $plugin_type_name => $plugin_type_info) {

// Quick hack: default to 'yaml' variant, as so far there's only

// migrations that we don't handle, which are YAML.

// TODO: when this is done in analysis, types we don't support should be

// filtered out.

$mapping[$plugin_type_name] = $types[$plugin_type_info['discovery']] ?? 'yaml';

}

// Special cases for plugins which have their own generator.

$mapping['validation.constraint'] = 'validation.constraint';

$mapping['element_info'] = 'element_info';

return $mapping;

}

}