You are here

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

class LogAssignActionForm in farmOS 2.x

Provides a log assign confirmation form.

Hierarchy

Expanded class hierarchy of LogAssignActionForm

1 string reference to 'LogAssignActionForm'
farm_owner.routing.yml in modules/core/owner/farm_owner.routing.yml
modules/core/owner/farm_owner.routing.yml

File

modules/core/owner/src/Form/LogAssignActionForm.php, line 18

Namespace

Drupal\farm_owner\Form
View source 
class LogAssignActionForm extends ConfirmFormBase {

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

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

  /**
   * The managed role permissions manager.
   *
   * @var \Drupal\farm_role\ManagedRolePermissionsManagerInterface
   */
  protected $managedRolePermissionsManager;

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

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

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

  /**
   * Constructs a LogAssignActionForm 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\farm_role\ManagedRolePermissionsManagerInterface $managed_role_permissions_manager
   *   The managed role permissions manager.
   * @param \Drupal\Core\Session\AccountInterface $user
   *   The current user.
   */
  public function __construct(PrivateTempStoreFactory $temp_store_factory, EntityTypeManagerInterface $entity_type_manager, ManagedRolePermissionsManagerInterface $managed_role_permissions_manager, AccountInterface $user) {
    $this->tempStore = $temp_store_factory
      ->get('log_assign_confirm');
    $this->entityTypeManager = $entity_type_manager;
    $this->managedRolePermissionsManager = $managed_role_permissions_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('plugin.manager.managed_role_permissions'), $container
      ->get('current_user'));
  }

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

  /**
   * {@inheritdoc}
   */
  public function getQuestion() {
    return $this
      ->formatPlural(count($this->entities), 'Are you sure you want to update assignment of this @item?', 'Are you sure you want to update assignment of 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('Assign');
  }

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

    // Load active users.
    $active_users = $this->entityTypeManager
      ->getStorage('user')
      ->loadByProperties([
      'status' => TRUE,
    ]);

    // Build options for form select.
    $user_options = array_map(function ($user) {
      return $user
        ->label();
    }, $active_users);
    $form['users'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Assign log(s) to'),
      '#description' => $this
        ->t('Select people to assign these logs to.'),
      '#options' => $user_options,
      '#multiple' => TRUE,
    ];
    $form['operation'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Append or replace'),
      '#description' => $this
        ->t('Select "Append" if you want to add users to the logs, but keep the existing assignments. Select "Replace" if you want to replace existing assignments 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 user assignment on accessible entities.
    $total_count = 0;
    foreach ($accessible_entities as $entity) {

      /** @var \Drupal\Core\Field\FieldItemListInterface $owner_field */
      if ($owner_field = $entity
        ->get('owner')) {

        // Save existing users if appending.
        $existing_owners = [];
        if ($form_state
          ->getValue('operation') === 'append') {
          $existing_owners = array_column($owner_field
            ->getValue(), 'target_id');
        }

        // Empty the owner field.
        $owner_field
          ->setValue([]);

        // Build list of owners.
        $new_owners = array_unique(array_merge($existing_owners, $form_state
          ->getValue('users')));
        foreach ($new_owners as $owner) {
          $owner_field
            ->appendItem($owner);
        }
        $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 update assignment of @count @item because you do not have the necessary permissions.', 'Could not update assignment of @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, 'Updated assignment of @count @item.', 'Updated assignment of @count @items', [
        '@item' => $this->entityType
          ->getSingularLabel(),
        '@items' => $this->entityType
          ->getPluralLabel(),
      ]));
    }
    $this->tempStore
      ->delete($this
      ->currentUser()
      ->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
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
LogAssignActionForm::$entities protected property The logs to assign.
LogAssignActionForm::$entityType protected property The entity type.
LogAssignActionForm::$entityTypeManager protected property The entity type manager.
LogAssignActionForm::$managedRolePermissionsManager protected property The managed role permissions manager.
LogAssignActionForm::$tempStore protected property The tempstore factory.
LogAssignActionForm::$user protected property The current user.
LogAssignActionForm::buildForm public function Form constructor. Overrides ConfirmFormBase::buildForm
LogAssignActionForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
LogAssignActionForm::getCancelUrl public function Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface::getCancelUrl
LogAssignActionForm::getConfirmText public function Returns a caption for the button that confirms the action. Overrides ConfirmFormBase::getConfirmText
LogAssignActionForm::getDescription public function Returns additional text to display as a description. Overrides ConfirmFormBase::getDescription
LogAssignActionForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
LogAssignActionForm::getQuestion public function Returns the question to ask the user. Overrides ConfirmFormInterface::getQuestion
LogAssignActionForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
LogAssignActionForm::__construct public function Constructs a LogAssignActionForm form object.
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.