HPC-9947: Add new plan element for plan caseload trend charts

Author: berliner

html/modules/custom/ghi_base_objects/src/Entity/BaseObjectFocusCountryInterface.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace Drupal\ghi_base_objects\Entity;
+
+use Drupal\ghi_base_objects\ApiObjects\Country;
+
+/**
+ * Provides an interface for defining base object that have a focus country.
+ *
+ * @ingroup ghi_base_objects
+ */
+interface BaseObjectFocusCountryInterface {
+
+  /**
+   * Get the focus country for the plan.
+   *
+   * @return \Drupal\ghi_base_objects\Entity\BaseObjectInterface|null
+   *   The country base object or NULL.
+   */
+  public function getFocusCountry();
+
+  /**
+   * Get the focus country override for the plan.
+   *
+   * @return object|null
+   *   A latLng object or NULL.
+   */
+  public function getFocusCountryOverride();
+
+  /**
+   * Get the focus country map location for the plan.
+   *
+   * @return \Drupal\ghi_base_objects\ApiObjects\Country|null
+   *   An object describing the map location or NULL.
+   */
+  public function getFocusCountryMapLocation(?Country $default_country = NULL);
+
+}

html/modules/custom/ghi_base_objects/src/Entity/BaseObjectInterface.php

@@ -6,7 +6,7 @@
 use Drupal\Core\Entity\EntityChangedInterface;
 
 /**
- * Provides an interface for defining Base object entities.
+ * Provides an interface for defining base object entities.
  *
  * @ingroup ghi_base_objects
  */

html/modules/custom/ghi_base_objects/src/Entity/BaseObjectMetaDataInterface.php

@@ -3,7 +3,7 @@
 namespace Drupal\ghi_base_objects\Entity;
 
 /**
- * Provides an interface for defining Base object entities.
+ * Provides an interface for defining base object entities with meta data.
  *
  * @ingroup ghi_base_objects
  */

html/modules/custom/ghi_base_objects/tests/src/Traits/BaseObjectTestTrait.php

@@ -39,12 +39,14 @@ protected function createBaseObjectType(array $values = []) {
       'label' => $this->randomString(),
       'hasYear' => FALSE,
     ];
-    $base_object_type = BaseObjectType::create($values);
-    $this->assertSame(SAVED_NEW, $base_object_type->save());
-    $this->assertInstanceOf(BaseObjectTypeInterface::class, $base_object_type);
-    $this->createField('base_object', $base_object_type->id(), 'integer', 'field_original_id', 'Source id');
-    if (!empty($values['hasYear'])) {
-      $this->createField('base_object', $base_object_type->id(), 'integer', 'field_year', 'Year');
+    $base_object_type = BaseObjectType::load($values['id']) ?: BaseObjectType::create($values);
+    if ($base_object_type->isNew()) {
+      $this->assertSame(SAVED_NEW, $base_object_type->save());
+      $this->assertInstanceOf(BaseObjectTypeInterface::class, $base_object_type);
+      $this->createField('base_object', $base_object_type->id(), 'integer', 'field_original_id', 'Source id');
+      if (!empty($values['hasYear'])) {
+        $this->createField('base_object', $base_object_type->id(), 'integer', 'field_year', 'Year');
+      }
     }
     return $base_object_type;
   }

html/modules/custom/ghi_blocks/src/Plugin/Block/GlobalPage/PlanTable.php

@@ -12,6 +12,7 @@
 use Drupal\ghi_blocks\Traits\GlobalSettingsTrait;
 use Drupal\ghi_blocks\Traits\PlanFootnoteTrait;
 use Drupal\ghi_blocks\Traits\TableSoftLimitTrait;
+use Drupal\ghi_blocks\Traits\TableTrait;
 use Drupal\ghi_plans\ApiObjects\Mocks\PlanOverviewPlanMock;
 use Drupal\ghi_plans\Traits\FtsLinkTrait;
 use Drupal\hpc_common\Helpers\ArrayHelper;
@@ -44,6 +45,7 @@ class PlanTable extends GHIBlockBase implements HPCDownloadExcelInterface, HPCDo
   use GlobalPlanOverviewBlockTrait;
   use GlobalSettingsTrait;
   use PlanFootnoteTrait;
+  use TableTrait;
   use TableSoftLimitTrait;
   use BlockCommentTrait;
   use FtsLinkTrait;
@@ -142,62 +144,22 @@ public function buildTableData($export = FALSE) {
     $header += [
       'name' => $this->t('Plans'),
       'type' => $this->t('Plan type'),
-      'inneed' => [
-        'data' => $this->t('People in need'),
-        'data-column-type' => 'amount',
-      ],
-      'targeted' => [
-        'data' => $this->t('People targeted'),
-        'data-column-type' => 'amount',
-      ],
-      'expected_reach' => [
-        'data' => $this->t('Estimated Reach'),
-        'data-column-type' => 'amount',
-      ],
-      'expected_reached' => [
-        'data' => $this->t('% Reached'),
-        'data-column-type' => 'amount',
-      ],
-      'latest_reach' => [
-        'data' => $this->t('People reached'),
-        'data-column-type' => 'percentage',
-      ],
-      'reached' => [
-        'data' => $this->t('% Reached'),
-        'data-column-type' => 'percentage',
-      ],
-      'requirements' => [
-        'data' => $this->t('Requirements'),
-        'data-column-type' => 'currency',
-      ],
-      'funding' => [
-        'data' => $this->t('Funding'),
-        'data-column-type' => 'currency',
-      ],
-      'coverage' => [
-        'data' => $this->t('% Funded'),
-        'data-column-type' => 'percentage',
-      ],
-      'status' => [
-        'data' => $this->t('Status'),
-        'data-column-type' => 'status',
-        'sortable' => FALSE,
-      ],
+      'inneed' => $this->buildHeaderColumn($this->t('People in need'), 'amount'),
+      'targeted' => $this->buildHeaderColumn($this->t('People targeted'), 'amount'),
+      'expected_reach' => $this->buildHeaderColumn($this->t('Estimated Reach'), 'amount'),
+      'expected_reached' => $this->buildHeaderColumn($this->t('% Reached'), 'percentage'),
+      'latest_reach' => $this->buildHeaderColumn($this->t('People reached'), 'percentage'),
+      'reached' => $this->buildHeaderColumn($this->t('% Reached'), 'percentage'),
+      'requirements' => $this->buildHeaderColumn($this->t('Requirements'), 'currency'),
+      'funding' => $this->buildHeaderColumn($this->t('Funding'), 'currency'),
+      'coverage' => $this->buildHeaderColumn($this->t('% Funded'), 'percentage'),
+      'status' => $this->buildHeaderColumn($this->t('Status'), 'status'),
     ];
     if ($export) {
       $header['in_gho'] = $this->t('In GHO');
-      $header['document'] = [
-        'data' => $this->t('Document'),
-        'data-column-type' => 'document',
-      ];
-      $header['link_ha'] = [
-        'data' => $this->t('Link to HA page'),
-        'data-column-type' => 'document',
-      ];
-      $header['link_fts'] = [
-        'data' => $this->t('Link to FTS page'),
-        'data-column-type' => 'document',
-      ];
+      $header['document'] = $this->buildHeaderColumn($this->t('Document'), 'document');
+      $header['link_ha'] = $this->buildHeaderColumn($this->t('Link to HA page'), 'document');
+      $header['link_fts'] = $this->buildHeaderColumn($this->t('Link to FTS page'), 'document');
     }
 
     $cache_tags = [];
@@ -241,19 +203,15 @@ public function buildTableData($export = FALSE) {
       $document_uri = $plan->getPlanDocumentUri();
 
       // Setup the column values.
-      $value_in_need = $in_need ? [
+      $value_in_need = [
         '#theme' => 'hpc_amount',
-        '#amount' => $in_need,
+        '#amount' => $in_need ?: '-',
         '#decimals' => $decimals,
-      ] : [
-        '#markup' => '-',
       ];
-      $value_targeted = $target ? [
+      $value_targeted = [
         '#theme' => 'hpc_amount',
-        '#amount' => $target,
+        '#amount' => $target ?: '-',
         '#decimals' => $decimals,
-      ] : [
-        '#markup' => '-',
       ];
       $value_expected_reach = [
         '#theme' => 'hpc_amount',
@@ -264,12 +222,10 @@ public function buildTableData($export = FALSE) {
         '#theme' => 'hpc_percent',
         '#ratio' => $expected_reached / 100,
       ];
-      $value_latest_reached = $latest_reached !== NULL ? [
+      $value_latest_reached = [
         '#theme' => 'hpc_amount',
-        '#amount' => $latest_reached,
+        '#amount' => $latest_reached ?? $this->t('Pending'),
         '#decimals' => $decimals,
-      ] : [
-        '#markup' => $this->t('Pending'),
       ];
       $value_reached = $reached_percent ? [
         '#theme' => 'hpc_percent',

html/modules/custom/ghi_blocks/src/Plugin/Block/Menu/SectionSwitcher.php

@@ -5,7 +5,6 @@
 use Drupal\Core\Block\BlockBase;
 use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
 use Drupal\ghi_base_objects\Traits\ShortNameTrait;
-use Drupal\ghi_plans\Entity\Plan;
 use Drupal\ghi_sections\Entity\SectionNodeInterface;
 use Drupal\ghi_sections\Traits\SectionPathTrait;
 use Symfony\Component\DependencyInjection\ContainerInterface;
@@ -113,46 +112,15 @@ public function build() {
   /**
    * Build the section switcher options.
    *
-   * @return \Drupal\ghi_sections\Entity\SectionNodeInterface[]
-   *   An array of section nodes to be used as options.
+   * @return \Drupal\ghi_sections\Entity\SectionNodeInterface[]|null
+   *   An array of section nodes to be used as options or NULL.
    */
   private function buildSectionSwitcherOptions() {
-
     $section_node = $this->getSectionNode();
     if (!$section_node) {
       return NULL;
     }
-
-    $base_object = $section_node->getBaseObject();
-    $sections = [];
-    if (!$section_node->get('field_year')->isEmpty()) {
-      // This is either a global section page or a section page with a base
-      // object that needs an additional year specified.
-      $args = array_filter([
-        'type' => $section_node->bundle(),
-        'field_base_object' => $base_object?->id(),
-      ]);
-      $candidates = $this->entityTypeManager->getStorage($section_node->getEntityTypeId())->loadByProperties($args);
-      foreach ($candidates as $candidate) {
-        $year = $candidate->get('field_year')->value;
-        $sections[$year] = $candidate;
-      }
-    }
-    elseif ($base_object && $base_object->hasField('field_focus_country')) {
-      // This is a section page with no year but with a focus country field,
-      // e.g. a plan based section page.
-      $sections = $this->getSectionsByBaseObjectFocusCountry();
-    }
-    elseif ($base_object) {
-      // This is a section page with no year, e.g. a plan based section page.
-      $sections = $this->getSectionsByBaseObjectCountryReference();
-    }
-
-    if (empty($sections)) {
-      return NULL;
-    }
-
-    return $sections;
+    return $this->sectionManager->getRelatedSections($section_node);
   }
 
   /**
@@ -180,122 +148,4 @@ private function getSectionNode() {
     return $section_node instanceof SectionNodeInterface ? $section_node : NULL;
   }
 
-  /**
-   * Get switcher options by a country reference on the sections base objects.
-   *
-   * @return \Drupal\ghi_sections\Entity\SectionNodeInterface[]
-   *   An array of section nodes keyed by the base object original id
-   */
-  private function getSectionsByBaseObjectFocusCountry() {
-    $options = [];
-    $section_node = $this->getSectionNode();
-    $base_object = $section_node->getBaseObject();
-    if (!$base_object || !$base_object->hasField('field_focus_country') || $base_object->get('field_focus_country')->isEmpty()) {
-      return $options;
-    }
-    $focus_country = $base_object->get('field_focus_country')->entity;
-
-    // Find other object candidates that have the same focus country.
-    /** @var \Drupal\ghi_base_objects\Entity\BaseObjectInterface[] $base_object_candidates */
-    $base_object_candidates = $this->entityTypeManager->getStorage($base_object->getEntityTypeId())->loadByProperties([
-      'type' => $base_object->bundle(),
-      'field_focus_country' => $focus_country->id(),
-    ]);
-
-    // If base object is a plan, thus looking for other plan base objects,
-    // apply filtering based on the plan type.
-    if ($base_object instanceof Plan) {
-      $base_object_candidates = array_filter($base_object_candidates, function (Plan $base_object_candidate) use ($base_object) {
-        // If the current base object is of type RRP, we want to retain only
-        // candidates that are also RRPs. If it's not an RRP, we only want
-        // other candiates that are not RRPs either.
-        return $base_object->isRrp() ? $base_object_candidate->isRrp() : !$base_object_candidate->isRrp();
-      });
-    }
-
-    return $this->getSectionOptionsForBaseObjects($section_node, $base_object_candidates);
-  }
-
-  /**
-   * Get switcher options by a country reference on the sections base objects.
-   *
-   * @return \Drupal\ghi_sections\Entity\SectionNodeInterface[]
-   *   An array of section nodes keyed by the base object original id
-   */
-  private function getSectionsByBaseObjectCountryReference() {
-    $options = [];
-    $section_node = $this->getSectionNode();
-    $base_object = $section_node->getBaseObject();
-    if (!$base_object || !$base_object->hasField('field_country') || $base_object->get('field_country')->isEmpty()) {
-      return $options;
-    }
-
-    // Get the list of all countries associated with this object.
-    $country_ids = array_map(function ($country) {
-      return $country->id();
-    }, $base_object->get('field_country')->referencedEntities());
-
-    // Find other object candidates that have at least one of these countries
-    // associated.
-    /** @var \Drupal\ghi_base_objects\Entity\BaseObjectInterface[] $base_object_candidates */
-    $base_object_candidates = $this->entityTypeManager->getStorage($base_object->getEntityTypeId())->loadByProperties([
-      'type' => $base_object->bundle(),
-      'field_country' => $country_ids,
-    ]);
-
-    // Then filter out the ones that don't share the full set of countries.
-    $base_object_candidates = array_filter($base_object_candidates, function ($base_object_candidate) use ($country_ids) {
-      $candidate_country_ids = array_map(function ($country) {
-        return $country->id();
-      }, $base_object_candidate->get('field_country')->referencedEntities());
-      return empty(array_diff($country_ids, $candidate_country_ids)) && count($candidate_country_ids) == count($country_ids);
-    });
-    if (empty($base_object_candidates)) {
-      return $options;
-    }
-    return $this->getSectionOptionsForBaseObjects($section_node, $base_object_candidates);
-  }
-
-  /**
-   * Get the section options for the given base object.
-   *
-   * @param \Drupal\ghi_sections\Entity\SectionNodeInterface $section_node
-   *   The current section node.
-   * @param \Drupal\ghi_base_objects\Entity\BaseObjectInterface[] $base_objects
-   *   The base objects.
-   *
-   * @return \Drupal\ghi_sections\Entity\SectionNodeInterface[]
-   *   An array of section nodes keyed by the base object original id.
-   */
-  private function getSectionOptionsForBaseObjects(SectionNodeInterface $section_node, array $base_objects) {
-    $base_object = $section_node->getBaseObject();
-    // Then load the sections associated to these objects.
-    /** @var \Drupal\ghi_sections\Entity\SectionNodeInterface[] $section_candidates */
-    $section_candidates = $this->entityTypeManager->getStorage($section_node->getEntityTypeId())->loadByProperties([
-      'type' => $section_node->bundle(),
-      'field_base_object' => array_keys($base_objects),
-    ]);
-    foreach ($section_candidates as $section_candidate) {
-      if (!$section_candidate->access('view')) {
-        continue;
-      }
-      $options[$section_candidate->getBaseObject()->getSourceId()] = $section_candidate;
-    }
-
-    // Sort the options.
-    if ($base_object->hasField('field_year')) {
-      // If the base object has a year field, use that for sorting.
-      usort($options, function ($section_a, $section_b) {
-        $year_a = $section_a->getBaseObject()->get('field_year')->value;
-        $year_b = $section_b->getBaseObject()->get('field_year')->value;
-        return $year_a - $year_b;
-      });
-    }
-    else {
-      // Otherwise just use the base objects original id as a best guess.
-      ksort($options);
-    }
-    return array_reverse($options);
-  }
-
 }