diff --git web/modules/contrib/charts_field_formatter/src/Plugin/Field/FieldFormatter/ChartsFieldFormatter.php web/modules/contrib/charts_field_formatter/src/Plugin/Field/FieldFormatter/ChartsFieldFormatter.php index cc6d190a..e9fb9e03 100755 --- web/modules/contrib/charts_field_formatter/src/Plugin/Field/FieldFormatter/ChartsFieldFormatter.php +++ web/modules/contrib/charts_field_formatter/src/Plugin/Field/FieldFormatter/ChartsFieldFormatter.php @@ -2,14 +2,15 @@ namespace Drupal\charts_field_formatter\Plugin\Field\FieldFormatter; +use Drupal\charts\Services\ChartsSettingsServiceInterface; +use Drupal\Component\Uuid\UuidInterface; use Drupal\Core\Field\FormatterBase; use Drupal\Core\Field\FieldItemListInterface; use Symfony\Component\DependencyInjection\ContainerInterface; use Drupal\Core\Plugin\ContainerFactoryPluginInterface; use Drupal\Core\Field\FieldDefinitionInterface; -use Drupal\charts\Services\ChartsSettingsService; use Drupal\Core\Messenger\MessengerInterface; -use Drupal\Component\Uuid\Php; +use Drupal\Core\Config\ConfigFactoryInterface; /** * Plugin implementation of the 'html_inject_formatter' formatter. @@ -24,21 +25,66 @@ */ class ChartsFieldFormatter extends FormatterBase implements ContainerFactoryPluginInterface { + /** + * The charts settings. + * + * @var \Drupal\charts\Services\ChartsSettingsServiceInterface + */ protected $chartSettings; + + /** + * The messenger service. + * + * @var \Drupal\Core\Messenger\MessengerInterface + */ protected $messenger; + + /** + * The UUID service. + * + * @var \Drupal\Component\Uuid\UuidInterface + */ protected $uuidService; /** - * Construct. + * The config factory service. * - * @param \Drupal\charts\Services\ChartsSettingsService $chartSettings - * Service ChartsSettingsService. + * @var \Drupal\Core\Config\ConfigFactoryInterface */ - public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, $label, $view_mode, array $third_party_settings, ChartsSettingsService $chartSettings, MessengerInterface $messenger, Php $uuidService) { + protected $configFactory; + + /** + * Constructs a ChartsFieldFormatter object. + * + * @param string $plugin_id + * The plugin_id for the formatter. + * @param mixed $plugin_definition + * The plugin implementation definition. + * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition + * The definition of the field to which the formatter is associated. + * @param array $settings + * The formatter settings. + * @param string $label + * The formatter label display setting. + * @param string $view_mode + * The view mode. + * @param array $third_party_settings + * Any third party settings. + * @param \Drupal\charts\Services\ChartsSettingsServiceInterface $chartSettings + * The chart settings service. + * @param \Drupal\Core\Messenger\MessengerInterface $messenger + * The messenger. + * @param \Drupal\Component\Uuid\UuidInterface $uuid_service + * The UUID service. + * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory + * The config factory service. + */ + public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, $label, $view_mode, array $third_party_settings, ChartsSettingsServiceInterface $chartSettings, MessengerInterface $messenger, UuidInterface $uuid_service, ConfigFactoryInterface $config_factory) { parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings); $this->chartSettings = $chartSettings->getChartsSettings(); $this->messenger = $messenger; - $this->uuidService = $uuidService; + $this->uuidService = $uuid_service; + $this->configFactory = $config_factory; } /** @@ -67,7 +113,8 @@ public static function create(ContainerInterface $container, array $configuratio $configuration['third_party_settings'], $container->get('charts.settings'), $container->get('messenger'), - $container->get('uuid') + $container->get('uuid'), + $container->get('config.factory') ); } @@ -80,7 +127,7 @@ public function viewElements(FieldItemListInterface $items, $langcode) { $library = $this->chartSettings['library']; $colors = $this->chartSettings['colors']; - $highchartsConfig = \Drupal::config('charts_highcharts.settings')->get(); + $highchartsConfig = $this->configFactory->get('charts_highcharts.settings')->get(); if (empty($library)) { $this->messenger->addError($this->t('You need to first configure Charts default settings')); return []; @@ -91,41 +138,43 @@ public function viewElements(FieldItemListInterface $items, $langcode) { $entity = $item->getEntity(); $title = (!is_null($entity->title)) ? $entity->title->value : ''; // Check if there field_chart_type in the entity then set the chart type of its value - // Otherwise set it from 'Default chart configuration' in /admin/config/content/charts + // Otherwise set it from 'Default chart configuration' in /admin/config/content/charts. if ($entity->hasField('field_chart_type') && $entity->get('field_chart_type')->value != '') { $chart_type = $entity->get('field_chart_type')->value; } else { - $chart_type = $this->chartSettings['type']; + $chart_type = $this->chartSettings['type']; } if (!empty($item->value)) { $tabledata = $item->value; - // No need for tabledata caption + // No need for tabledata caption. if (isset($tabledata['caption'])) { unset($tabledata['caption']); } $total_rows = sizeof($tabledata); $total_cols = sizeof($tabledata[0]); - //Handle the CSV column by column to match Highcharts pattern + // Handle the CSV column by column to match Highcharts pattern. for ($col = 0; $col < $total_cols; $col++) { $data = []; for ($row = 0; $row < $total_rows; $row++) { if ($col == 0) { - //The first column of the CSV file is the categories + // The first column of the CSV file is the categories. $categories[] = $tabledata[$row][$col]; } else { if ($row == 0) { - //The series name is the first cell in the column + // The series name is the first cell in the column. $series_name = $tabledata[$row][$col]; } elseif ($tabledata[$row][$col] != '') { - // Remove commas from numeric strings - if(preg_match("/^[0-9,]+$/", $tabledata[$row][$col])) $tabledata[$row][$col] = str_replace(',', '', $tabledata[$row][$col]); - //Handle the minus values and make sure the value is stored as number + // Remove commas from numeric strings. + if (preg_match("/^[0-9,]+$/", $tabledata[$row][$col])) { + $tabledata[$row][$col] = str_replace(',', '', $tabledata[$row][$col]); + } + // Handle the minus values and make sure the value is stored as number. if (substr($tabledata[$row][$col], -1) == '-' || substr($tabledata[$row][$col], 1) == '-') { $tabledata[$row][$col] = floatval($tabledata[$row][$col]) * -1; } @@ -137,13 +186,13 @@ public function viewElements(FieldItemListInterface $items, $langcode) { } } - //The first column is not a series data, it's the categories + // The first column is not a series data, it's the categories. if ($col == 0) { $xaxis_title = array_shift($categories); continue; } - //Handle the 'Pie' chart type because it's only accept 2 columns + // Handle the 'Pie' chart type because it's only accept 2 columns. if ($chart_type == 'pie' && $col > 1) { break; } @@ -163,7 +212,7 @@ public function viewElements(FieldItemListInterface $items, $langcode) { 'title' => $title, 'xaxis_title' => $xaxis_title, 'yaxis_title' => '', - 'data_labels'=> $this->chartSettings['data_labels'], + 'data_labels' => $this->chartSettings['data_labels'], 'yaxis_min' => '', 'yaxis_max' => '', 'three_dimensional' => FALSE, @@ -185,7 +234,7 @@ public function viewElements(FieldItemListInterface $items, $langcode) { 'yellow_to' => $this->chartSettings['yellow_to'], 'green_from' => $this->chartSettings['green_from'], 'green_to' => $this->chartSettings['green_to'], - 'tooltips' => $this->chartSettings['tooltips'] + 'tooltips' => $this->chartSettings['tooltips'], ]; $chart_id = 'chart-' . $this->uuidService->generate();