content_planner-8.x-1.x-dev/modules/content_kanban/src/Form/KanbanFilterForm.php

<?php

namespace Drupal\content_kanban\Form;

use Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException;
use Drupal\Component\Plugin\Exception\PluginNotFoundException;
use Drupal\Core\Form\FormBase;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Link;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Implements KanbanFilterForm class.
 */
class KanbanFilterForm extends FormBase {

  /**
   * The Content Moderation service.
   *
   * @var \Drupal\content_planner\ContentModerationService
   */
  protected $contentModerationService;

  /**
   * An array with the form params.
   *
   * @var array
   */
  protected $formParams = [];

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    $instance = parent::create($container);
    $instance->contentModerationService = $container->get('content_planner.content_moderation_service');
    $instance->entityTypeManager = $container->get('entity_type.manager');

    return $instance;
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'content_kanban_filter_form';
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, $params = []) {

    $this->formParams = $params;

    $form_state->setMethod('GET');

    $form['filters'] = [
      '#type' => 'fieldset',
      '#title' => $this->t('Filters'),
      '#collapsible' => FALSE,
      '#collapsed' => FALSE,
      '#attributes' => [
        'class' => ['form--inline'],
      ],
    ];

    // User ID.
    $form['filters']['filter_uid'] = [
      '#type' => 'select',
      '#title' => $this->t('User'),
      '#options' => $this->getUserOptions(),
      '#required' => FALSE,
      '#empty_value' => '',
      '#empty_option' => $this->t('- Select -'),
      '#default_value' => self::getUserIdFilter(),
    ];

    // User ID.
    $form['filters']['filter_state'] = [
      '#type' => 'select',
      '#title' => $this->t('States'),
      '#options' => $this->getStateOptions(),
      '#required' => FALSE,
      '#empty_value' => '',
      '#empty_option' => $this->t('All'),
      '#default_value' => self::getStateFilter(),
    ];

    $form['filters']['filter_date_range'] = [
      '#type' => 'select',
      '#title' => $this->t('Date range'),
      '#options' => self::getDateRangeOptions(),
      '#required' => FALSE,
      '#empty_value' => '',
      '#empty_option' => $this->t('All'),
      '#default_value' => self::getDateRangeFilter(),
    ];

    $form['filters']['filter_content_type'] = [
      '#type' => 'select',
      '#title' => $this->t('Entity type'),
      '#options' => self::getContentTypeOptions($params['workflow_id']),
      '#required' => FALSE,
      '#empty_value' => '',
      '#empty_option' => $this->t('All'),
      '#default_value' => self::getContentTypeFilter(),
    ];

    $form['filters']['search'] = [
      '#type' => 'textfield',
      '#title' => $this->t('Instant Search'),
      '#required' => FALSE,
    ];

    // Actions.
    $form['filters']['actions'] = [
      '#type' => 'actions',
    ];

    // Submit button.
    $form['filters']['actions']['submit'] = [
      '#type' => 'submit',
      '#value' => $this->t('Search'),
    ];

    $form['filters']['actions']['reset'] = [
      '#markup' => Link::createFromRoute(
        $this->t('Reset'),
        'content_kanban.kanban'
      )->toString(),
    ];

    return $form;
  }

  /**
   * Gets the User options.
   *
   * @return array
   *   Returns an array with the user options if any or an empty array
   *   otherwise.
   */
  protected function getUserOptions() {

    $options = [];

    // Load Content Moderation entities.
    $content_moderation_entities = $this->contentModerationService->getEntityContentModerationEntities($this->formParams['workflow_id']);
    foreach ($content_moderation_entities as $content_moderation_entity) {
      // Get the entity id and entity type id.
      $entityId = $content_moderation_entity->content_entity_id->value;
      $entityTypeId = $content_moderation_entity->content_entity_type_id->value;
      // Get the entity keys and the entity loaded.
      try {
        $entityType = $this->entityTypeManager->getStorage($entityTypeId);
        $entityKeyUserId = $entityType->getEntityType()->hasKey('owner') ? $entityType->getEntityType()->getKey('owner') : $entityType->getEntityType()->getKey('uid');
        if ($entity = $entityType->load($entityId)) {
          $userId = $entity->$entityKeyUserId->getValue();
          if ($user_id = $userId[0]['target_id']) {
            if (!array_key_exists($user_id, $options)) {

              // Load user if existing.
              if ($user = $this->entityTypeManager->getStorage('user')->load($user_id)) {
                // Add to options.
                $options[$user_id] = $user->name->value;
              }
            }
          }
        }
      }
      catch (InvalidPluginDefinitionException $e) {
        \Drupal\Component\Utility\DeprecationHelper::backwardsCompatibleCall(\Drupal::VERSION, '10.1.0', fn() => \Drupal\Core\Utility\Error::logException(\Drupal::logger('content_kanban'), $e), fn() => watchdog_exception('content_kanban', $e));
      }
      catch (PluginNotFoundException $e) {
        \Drupal\Component\Utility\DeprecationHelper::backwardsCompatibleCall(\Drupal::VERSION, '10.1.0', fn() => \Drupal\Core\Utility\Error::logException(\Drupal::logger('content_kanban'), $e), fn() => watchdog_exception('content_kanban', $e));
      }
    }

    return $options;
  }

  /**
   * Gets the State options.
   *
   * @return array
   *   Returns an array with the state options.
   */
  protected function getStateOptions() {

    $options = [];

    foreach ($this->formParams['states'] as $state_id => $state) {
      $options[$state_id] = $state['label'];
    }

    return $options;
  }

  /**
   * Gets the Date Range options.
   *
   * @return array
   *   Returns an array with the date range options.
   */
  public static function getDateRangeOptions() {

    // Static for now, maybe it needs to be more dynamic later.
    $options = [];
    // @todo t() is bad - how can we get the translation service (without using global context)
    $options['1']   = t('1 Day');
    $options['7']   = t('7 Days');
    $options['30']  = t('30 Days');
    $options['90']  = t('90 Days');
    $options['365'] = t('Year');

    return $options;
  }

  /**
   * Gets the Date Range options.
   *
   * @return array
   *   Returns an array with the date range options.
   */
  public function getContentTypeOptions($workflow_id) {
    $options = [];
    $workflow = $this->entityTypeManager->getStorage('workflow')->load($workflow_id);
    $entityTypes = $workflow->get('type_settings')['entity_types'];

    foreach ($entityTypes as $entityTypeId => $bundles) {
      $entityType = $this->entityTypeManager->getDefinition($entityTypeId);
      $bundleEntities = $this->entityTypeManager
        ->getStorage($entityType->getBundleEntityType())
        ->loadMultiple($bundles);

      foreach ($bundleEntities as $bundle => $entity) {
        $options[(string) $entityType->getLabel()][$bundle] = $entity->label();
      }
    }

    return $options;
  }

  /**
   * Gets the User ID filter from request.
   *
   * @return int|null
   *   Returns the filter_uid value if it exists, NULL otherwise.
   */
  public static function getUserIdFilter() {

    if (\Drupal::request()->query->has('filter_uid')) {
      return \Drupal::request()->query->getInt('filter_uid');
    }

    return NULL;
  }

  /**
   * Gets the State filter from request.
   *
   * @return int|null
   *   Returns the filter_state value if it exists, NULL otherwise.
   */
  public static function getStateFilter() {

    if (\Drupal::request()->query->has('filter_state')) {
      return \Drupal::request()->query->get('filter_state');
    }

    return NULL;
  }

  /**
   * Gets the State Date Range from request.
   *
   * @return int|null
   *   Returns the filter_date_range value if it exists, NULL otherwise.
   */
  public static function getDateRangeFilter() {

    if (\Drupal::request()->query->has('filter_date_range')) {
      return \Drupal::request()->query->get('filter_date_range');
    }
    else {
      $config = \Drupal::config(SettingsForm::CONFIG_NAME);

      $date_range = $config->get('default_filter_date_range');

      if ($date_range) {
        return $date_range;
      }
    }

    return SettingsForm::DEFAULT_DATE_RANGE_VALUE;
  }

  /**
   * Gets the content type filter from request.
   *
   * @return string|null
   *   Returns the filter_content_type value if it exists, NULL otherwise.
   */
  public static function getContentTypeFilter() {

    if (\Drupal::request()->query->has('filter_content_type')) {
      return \Drupal::request()->query->get('filter_content_type');
    }

    return NULL;
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {

  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {

  }

}