monitoring-8.x-1.x-dev/src/Plugin/monitoring/SensorPlugin/PaymentTurnoverSensorPlugin.php

<?php
/**
 * @file
 * Contains \Drupal\monitoring\Plugin\monitoring\SensorPlugin\SensorPaymentTurnover.
 */

namespace Drupal\monitoring\Plugin\monitoring\SensorPlugin;

use Drupal\Core\StringTranslation\TranslatableMarkup;
use Drupal\monitoring\Attribute\SensorPlugin;
use Drupal\monitoring\Result\SensorResultInterface;
use Drupal\payment\Entity\Payment;

/**
 * Monitors payment turnover stats.
 *
 * A custom database query is used here instead of entity manager for
 * performance reasons.
 */
#[SensorPlugin(
  id: 'payment_turnover',
  label: new TranslatableMarkup('Payment Turnover'),
  provider: 'payment',
  addable: FALSE,
  metric_type: 'gauge',
  report_execution_time: TRUE,
)]
class PaymentTurnoverSensorPlugin extends ContentEntityAggregatorSensorPlugin {

  /**
   * {@inheritdoc}
   */
  protected $configurableEntityType = FALSE;

  /**
   * {@inheritdoc}
   */
  protected $configurableTimestampField = FALSE;

  /**
   * {@inheritdoc}
   */
  public function runSensor(SensorResultInterface $sensor_result) {
    // @todo This will not perform for large number of payments.
    // @todo Use a condition for the currency when available again.
    $ids = $this->getEntityQuery()->execute();

    $entity_type_id = $this->sensorConfig->getSetting('entity_type');
    $payments = $this->entityTypeManager
      ->getStorage($entity_type_id)
      ->loadMultiple($ids);

    $turnover = 0;
    foreach ($payments as $payment) {
      foreach ($payment->getLineItems() as $line_item) {
        // @todo Add a form for this setting.
        if ($line_item->getCurrencyCode() == $this->sensorConfig->getSetting('currency_code')) {
          $turnover += $line_item->getAmount();
        }
      }
    }
    $sensor_result->setValue($turnover);
  }

  /**
   * {@inheritdoc}
   */
  public function getDefaultConfiguration() {
    $default_config = array(
      'settings' => array(
        'entity_type' => 'payment',
      ),
    );
    return $default_config;
  }

}