Commit 0e82d507 authored by Daniel Cothran's avatar Daniel Cothran Committed by Daniel Cothran
Browse files

Issue #3277589 by andileco: Clean up code documentation, add return types, etc.

parent 5a088838

src/Plugin/views/style/ChartsPluginStyleChart.php

+13 −13
Changes for src/Plugin/views/style/ChartsPluginStyleChart.php: 13 added lines, 13 removed lines.
Original line number Diff line number Diff line
@@ -138,7 +138,7 @@ class ChartsPluginStyleChart extends StylePluginBase implements ContainerFactory 
  /**

   * {@inheritdoc}

   */

  protected function defineOptions(): array {

  protected function defineOptions() {

    $options = parent::defineOptions();

    $charts_settings = $this->configFactory->get('charts.settings');

    $charts_default_settings = $charts_settings->get('charts_default_settings') ?? [];
@@ -211,7 +211,7 @@ class ChartsPluginStyleChart extends StylePluginBase implements ContainerFactory 
  /**

   * {@inheritdoc}

   */

  public function validate(): array {

  public function validate() {

    $errors = parent::validate();

    $chart_settings = $this->options['chart_settings'];

    $selected_data_fields = !empty($chart_settings['fields']['data_providers']) && is_array($chart_settings['fields']['data_providers']) ? $this->getSelectedDataFields($chart_settings['fields']['data_providers']) : NULL;
@@ -227,7 +227,7 @@ class ChartsPluginStyleChart extends StylePluginBase implements ContainerFactory 
  /**

   * {@inheritdoc}

   */

  public function render(): array {

  public function render() {

    $field_handlers = $this->view->getHandlers('field');

    $chart_settings = $this->options['chart_settings'];

    $chart_fields = $chart_settings['fields'];
@@ -556,7 +556,7 @@ class ChartsPluginStyleChart extends StylePluginBase implements ContainerFactory 
   * @return array

   *   Children Chart Display.

   */

  public function getChildrenChartDisplays(): array {

  public function getChildrenChartDisplays() {

    $children_displays = $this->displayHandler->getAttachedDisplays();

    foreach ($children_displays as $key => $child) {

      $display_handler = $this->view->displayHandlers->get($child);
@@ -572,7 +572,7 @@ class ChartsPluginStyleChart extends StylePluginBase implements ContainerFactory 
  /**

   * {@inheritdoc}

   */

  public function calculateDependencies(): array {

  public function calculateDependencies() {

    $dependencies = [];



    if (!empty($this->options['library'])) {
@@ -594,7 +594,7 @@ class ChartsPluginStyleChart extends StylePluginBase implements ContainerFactory 
   * @return \Drupal\Component\Render\MarkupInterface|float|null

   *   The value.

   */

  public function processNumberValueFromField($number, $field): mixed {

  public function processNumberValueFromField($number, $field) {

    if (is_array($this->getField($number, $field))) {

      $value = $this->getField($number, $field)->__toString();

    }
@@ -629,7 +629,7 @@ class ChartsPluginStyleChart extends StylePluginBase implements ContainerFactory 
   * @return array

   *   The fields.

   */

  private function getSelectedDataFields(array $data_providers): array {

  private function getSelectedDataFields(array $data_providers) {

    return array_filter($data_providers, function ($value) {



      return !empty($value['enabled']);
@@ -642,7 +642,7 @@ class ChartsPluginStyleChart extends StylePluginBase implements ContainerFactory 
   * @return string

   *   The Label Field key.

   */

  private function getLabelFieldKey(): string {

  private function getLabelFieldKey() {

    if (!isset($this->labelFieldKey)) {

      $field_handlers = $this->view->getHandlers('field');

      $chart_settings = $this->options['chart_settings'];
@@ -666,7 +666,7 @@ class ChartsPluginStyleChart extends StylePluginBase implements ContainerFactory 
   *

   * @return void

   */

  private function groupedChartElementBuild(array &$chart, array $sets, array $data_fields): void {

  private function groupedChartElementBuild(array &$chart, array $sets, array $data_fields) {

    $original_xaxis = $chart['xaxis'];

    $xaxis_labels = [];

    $label_field_key = $this->getLabelFieldKey();
@@ -734,7 +734,7 @@ class ChartsPluginStyleChart extends StylePluginBase implements ContainerFactory 
   * @return array

   *   The render array of the chart settings.

   */

  public static function groupingChartSettingsAjaxCallback(array $form, FormStateInterface $form_state): array {

  public static function groupingChartSettingsAjaxCallback(array $form, FormStateInterface $form_state) {

    return $form['options']['style_options']['chart_settings'];

  }
@@ -748,7 +748,7 @@ class ChartsPluginStyleChart extends StylePluginBase implements ContainerFactory 
   * @return string

   *   The color.

   */

  private function extractGroupedSelectedColorByEntity(EntityField $view_entity_field, ResultRow $row, string $group_field_name): string {

  private function extractGroupedSelectedColorByEntity(EntityField $view_entity_field, ResultRow $row, string $group_field_name) {

    $chart_settings = $this->options['chart_settings'];

    $colors_settings = $chart_settings['fields']['entity_grouping']['selected_method']['colors'] ?? [];

    /** @var \Drupal\Core\Entity\ContentEntityInterface $host_entity */
@@ -775,7 +775,7 @@ class ChartsPluginStyleChart extends StylePluginBase implements ContainerFactory 
   * @return string

   *   The color.

   */

  private function extractGroupedSelectedColorOnReferencedEntityField(EntityField $view_entity_field, ResultRow $row, string $group_field_name): string {

  private function extractGroupedSelectedColorOnReferencedEntityField(EntityField $view_entity_field, ResultRow $row, string $group_field_name) {

    $chart_settings = $this->options['chart_settings'];

    $color_field_name = $chart_settings['fields']['entity_grouping']['selected_method']['color_field_name'] ?? '';

    if (!$color_field_name) {
@@ -805,7 +805,7 @@ class ChartsPluginStyleChart extends StylePluginBase implements ContainerFactory 
   * @return array

   *   $processed_data

   */

  private function alignSubchartData(array $parent_labels, array $child_mapped_data, array $data): array {

  private function alignSubchartData(array $parent_labels, array $child_mapped_data, array $data) {

    $child_labels = array_keys($child_mapped_data);

    if ($parent_labels === $child_labels) {

      return $data;