You are here

Home » API reference » farmOS 2.x » EntityFlagActionForm.php

class EntityFlagActionForm in farmOS 2.x

Provides an entity flag action form.

Hierarchy

Expanded class hierarchy of EntityFlagActionForm

See also

\Drupal\farm_flag\Plugin\Action\EntityFlag

\Drupal\Core\Entity\Form\DeleteMultipleForm

1 file declares its use of EntityFlagActionForm
farm_flag.module in modules/core/flag/farm_flag.module
The farmOS Flags module.

File

modules/core/flag/src/Form/EntityFlagActionForm.php, line 21

Namespace

Drupal\farm_flag\Form
View source 
class EntityFlagActionForm extends ConfirmFormBase {

  /**
   * The tempstore factory.
   *
   * @var \Drupal\Core\TempStore\SharedTempStore
   */
  protected $tempStore;

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

  /**
   * The entity field manager.
   *
   * @var \Drupal\Core\Entity\EntityFieldManagerInterface
   */
  protected $entityFieldManager;

  /**
   * The current user.
   *
   * @var \Drupal\Core\Session\AccountInterface
   */
  protected $user;

  /**
   * The entity type.
   *
   * @var \Drupal\Core\Entity\EntityTypeInterface
   */
  protected $entityType;

  /**
   * The entities to flag.
   *
   * @var \Drupal\Core\Entity\EntityInterface[]
   */
  protected $entities;

  /**
   * The entity flag field name.
   *
   * @var string
   */
  protected $flagFieldName = 'flag';

  /**
   * Constructs an EntityFlagActionForm form object.
   *
   * @param \Drupal\Core\TempStore\PrivateTempStoreFactory $temp_store_factory
   *   The tempstore factory.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\Core\Entity\EntityFieldManagerInterface $entity_field_manager
   *   The entity field manager.
   * @param \Drupal\Core\Session\AccountInterface $user
   *   The current user.
   */
  public function __construct(PrivateTempStoreFactory $temp_store_factory, EntityTypeManagerInterface $entity_type_manager, EntityFieldManagerInterface $entity_field_manager, AccountInterface $user) {
    $this->tempStore = $temp_store_factory
      ->get('entity_flag_confirm');
    $this->entityTypeManager = $entity_type_manager;
    $this->entityFieldManager = $entity_field_manager;
    $this->user = $user;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('tempstore.private'), $container
      ->get('entity_type.manager'), $container
      ->get('entity_field.manager'), $container
      ->get('current_user'));
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {

    // Get entity type ID from the route because ::buildForm has not yet been
    // called.
    $entity_type_id = $this
      ->getRouteMatch()
      ->getParameter('entity_type_id');
    return $entity_type_id . '_flag_action_confirm_form';
  }

  /**
   * {@inheritdoc}
   */
  public function getQuestion() {
    return $this
      ->formatPlural(count($this->entities), 'Are you sure you want to flag this @item?', 'Are you sure you want to flag these @items?', [
      '@item' => $this->entityType
        ->getSingularLabel(),
      '@items' => $this->entityType
        ->getPluralLabel(),
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function getCancelUrl() {
    if ($this->entityType
      ->hasLinkTemplate('collection')) {
      return new Url('entity.' . $this->entityType
        ->id() . '.collection');
    }
    else {
      return new Url('<front>');
    }
  }

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

  /**
   * {@inheritdoc}
   */
  public function getConfirmText() {
    return $this
      ->t('Flag');
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, $entity_type_id = NULL) {
    $this->entityType = $this->entityTypeManager
      ->getDefinition($entity_type_id);
    $this->entities = $this->tempStore
      ->get($this->user
      ->id() . ':' . $entity_type_id);
    if (empty($entity_type_id) || empty($this->entities)) {
      return new RedirectResponse($this
        ->getCancelUrl()
        ->setAbsolute()
        ->toString());
    }

    // Get allowed values for the selected entities.
    // We find the intersection of all the allowed values to ensure that
    // disallowed flags cannot be assigned.
    $allowed_values = [];
    $base_field_definitions = $this->entityFieldManager
      ->getBaseFieldDefinitions($entity_type_id);
    if (!empty($base_field_definitions['flag'])) {
      foreach ($this->entities as $entity) {
        $entity_allowed_values = farm_flag_field_allowed_values($base_field_definitions['flag'], $entity);
        if (empty($allowed_values)) {
          $allowed_values = $entity_allowed_values;
        }
        else {
          $allowed_values = array_intersect_assoc($allowed_values, $entity_allowed_values);
        }
      }
    }
    $form['flags'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Flag'),
      '#description' => $this
        ->t('Select the flags that should be attached to the record(s).'),
      '#options' => $allowed_values,
      '#multiple' => TRUE,
    ];
    $form['operation'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Append or replace'),
      '#description' => $this
        ->t('Select "Append" if you want to add flags to the records, but keep the existing flags. Select "Replace" if you want to replace existing flags with the ones specified above.'),
      '#options' => [
        'append' => $this
          ->t('Append'),
        'replace' => $this
          ->t('Replace'),
      ],
      '#default_value' => 'append',
      '#required' => TRUE,
    ];
    return parent::buildForm($form, $form_state);
  }

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

    // Filter out entities the user doesn't have access to.
    $inaccessible_entities = [];
    $accessible_entities = [];
    foreach ($this->entities as $entity) {
      if (!$entity
        ->access('update', $this
        ->currentUser())) {
        $inaccessible_entities[] = $entity;
        continue;
      }
      $accessible_entities[] = $entity;
    }

    // Update flags on accessible entities.
    $total_count = 0;
    foreach ($accessible_entities as $entity) {

      /** @var \Drupal\Core\Field\FieldItemListInterface $flag_field */
      if ($flag_field = $entity
        ->get($this->flagFieldName)) {

        // Save existing flags if appending.
        $existing_flags = [];
        if ($form_state
          ->getValue('operation') === 'append') {
          $existing_flags = array_column($flag_field
            ->getValue(), 'value');
        }

        // Empty the flag field.
        $flag_field
          ->setValue([]);
        $new_flags = array_unique(array_merge($existing_flags, $form_state
          ->getValue('flags')));
        foreach ($new_flags as $flag) {
          $flag_field
            ->appendItem($flag);
        }
        $entity
          ->save();
        $total_count++;
      }
    }

    // Add warning message for inaccessible entities.
    if (!empty($inaccessible_entities)) {
      $inaccessible_count = count($inaccessible_entities);
      $this
        ->messenger()
        ->addWarning($this
        ->formatPlural($inaccessible_count, 'Could not flag @count @item because you do not have the necessary permissions.', 'Could not flag @count @items because you do not have the necessary permissions.', [
        '@item' => $this->entityType
          ->getSingularLabel(),
        '@items' => $this->entityType
          ->getPluralLabel(),
      ]));
    }

    // Add confirmation message.
    if (!empty($total_count)) {
      $this
        ->messenger()
        ->addStatus($this
        ->formatPlural($total_count, 'Flagged @count @item.', 'Flagged @count @items', [
        '@item' => $this->entityType
          ->getSingularLabel(),
        '@items' => $this->entityType
          ->getPluralLabel(),
      ]));
    }
    $this->tempStore
      ->delete($this
      ->currentUser()
      ->id() . ':' . $this->entityType
      ->id());
    $form_state
      ->setRedirectUrl($this
      ->getCancelUrl());
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfirmFormBase::getCancelText public function Returns a caption for the link which cancels the action. Overrides ConfirmFormInterface::getCancelText 2
ConfirmFormBase::getFormName public function Returns the internal name used to refer to the confirmation item. Overrides ConfirmFormInterface::getFormName
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
EntityFlagActionForm::$entities protected property The entities to flag.
EntityFlagActionForm::$entityFieldManager protected property The entity field manager.
EntityFlagActionForm::$entityType protected property The entity type.
EntityFlagActionForm::$entityTypeManager protected property The entity type manager.
EntityFlagActionForm::$flagFieldName protected property The entity flag field name.
EntityFlagActionForm::$tempStore protected property The tempstore factory.
EntityFlagActionForm::$user protected property The current user.
EntityFlagActionForm::buildForm public function Form constructor. Overrides ConfirmFormBase::buildForm
EntityFlagActionForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
EntityFlagActionForm::getCancelUrl public function Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface::getCancelUrl
EntityFlagActionForm::getConfirmText public function Returns a caption for the button that confirms the action. Overrides ConfirmFormBase::getConfirmText
EntityFlagActionForm::getDescription public function Returns additional text to display as a description. Overrides ConfirmFormBase::getDescription
EntityFlagActionForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
EntityFlagActionForm::getQuestion public function Returns the question to ask the user. Overrides ConfirmFormInterface::getQuestion
EntityFlagActionForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
EntityFlagActionForm::__construct public function Constructs an EntityFlagActionForm form object.
FormBase::$configFactory protected property The config factory. 3
FormBase::$requestStack protected property The request stack. 1
FormBase::$routeMatch protected property The route match.
FormBase::config protected function Retrieves a configuration object.
FormBase::configFactory protected function Gets the config factory for this form. 3
FormBase::container private function Returns the service container.
FormBase::currentUser protected function Gets the current user.
FormBase::getRequest protected function Gets the request object.
FormBase::getRouteMatch protected function Gets the route match.
FormBase::logger protected function Gets the logger for a specific channel.
FormBase::redirect protected function Returns a redirect response object for the specified route.
FormBase::resetConfigFactory public function Resets the configuration factory.
FormBase::setConfigFactory public function Sets the config factory for this form.
FormBase::setRequestStack public function Sets the request stack object to use.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 72
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 27
MessengerTrait::messenger public function Gets the messenger. 27
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
StringTranslationTrait::$stringTranslation protected property The string translation service. 4
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.