You are here

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

class AssetGroupActionForm in farmOS 2.x

Provides an asset group confirmation form.

Hierarchy

Expanded class hierarchy of AssetGroupActionForm

1 string reference to 'AssetGroupActionForm'
farm_group.routing.yml in modules/asset/group/farm_group.routing.yml
modules/asset/group/farm_group.routing.yml

File

modules/asset/group/src/Form/AssetGroupActionForm.php, line 19

Namespace

Drupal\farm_group\Form
View source 
class AssetGroupActionForm extends ConfirmFormBase {

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

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

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

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

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

  /**
   * Constructs an AssetGroupActionForm 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\Session\AccountInterface $user
   *   The current user.
   */
  public function __construct(PrivateTempStoreFactory $temp_store_factory, EntityTypeManagerInterface $entity_type_manager, AccountInterface $user) {
    $this->tempStore = $temp_store_factory
      ->get('asset_group_confirm');
    $this->entityTypeManager = $entity_type_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('current_user'));
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $this->entityType = $this->entityTypeManager
      ->getDefinition('asset');
    $this->entities = $this->tempStore
      ->get($this->user
      ->id());
    if (empty($this->entityType) || empty($this->entities)) {
      return new RedirectResponse($this
        ->getCancelUrl()
        ->setAbsolute()
        ->toString());
    }
    $form['date'] = [
      '#type' => 'datelist',
      '#title' => $this
        ->t('Date'),
      '#default_value' => new DrupalDateTime(),
      '#date_part_order' => [
        'year',
        'month',
        'day',
      ],
      '#date_year_range' => '-15:+15',
      '#required' => TRUE,
    ];
    $form['group'] = [
      '#type' => 'entity_autocomplete',
      '#title' => $this
        ->t('Group'),
      '#description' => $this
        ->t('The groups to assign the asset to. Leave blank to un-assign an asset from groups.'),
      '#target_type' => 'asset',
      '#selection_handler' => 'views',
      '#selection_settings' => [
        'view' => [
          'view_name' => 'farm_group_reference',
          'display_name' => 'entity_reference',
        ],
        'match_operator' => 'CONTAINS',
        'match_limit' => 10,
      ],
      '#tags' => TRUE,
      '#validate_reference' => FALSE,
      '#maxlength' => 1024,
    ];
    $form['done'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('This membership change has taken place (mark the log as done)'),
    ];
    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;
    }

    // Create an observation log to group the assets.
    if ($form_state
      ->getValue('confirm') && !empty($accessible_entities)) {

      // Load group assets.
      $groups = [];
      $group_ids = array_column($form_state
        ->getValue('group', []), 'target_id');
      if (!empty($group_ids)) {
        $groups = $this->entityTypeManager
          ->getStorage('asset')
          ->loadMultiple($group_ids);
      }

      /** @var \Drupal\Core\Datetime\DrupalDateTime $date */
      $date = $form_state
        ->getValue('date');
      $done = (bool) $form_state
        ->getValue('done', FALSE);

      // Generate a name for the log.
      $asset_names = farm_log_asset_names_summary($accessible_entities);
      $group_names = farm_log_asset_names_summary($groups);
      $log_name = $this
        ->t('Group :assets into :groups', [
        ':assets' => $asset_names,
        ':groups' => $group_names,
      ]);

      // Create the log.
      $log = Log::create([
        'name' => $log_name,
        'type' => 'observation',
        'timestamp' => $date
          ->getTimestamp(),
        'asset' => $accessible_entities,
        'is_group_assignment' => TRUE,
        'group' => $groups,
      ]);

      // Mark as done.
      if ($done !== FALSE) {
        $log
          ->get('status')
          ->first()
          ->applyTransitionById('done');
      }
      $log
        ->save();
      $this
        ->messenger()
        ->addMessage($this
        ->t('Log created: <a href=":uri">%log_label</a>', [
        ':uri' => $log
          ->toUrl()
          ->toString(),
        '%log_label' => $log
          ->label(),
      ]));
    }

    // Add warning message for inaccessible entities.
    if (!empty($inaccessible_entities)) {
      $inaccessible_count = count($inaccessible_entities);
      $this
        ->messenger()
        ->addWarning($this
        ->formatPlural($inaccessible_count, 'Could not group @count @item because you do not have the necessary permissions.', 'Could not group @count @items because you do not have the necessary permissions.', [
        '@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
AssetGroupActionForm::$entities protected property The assets to group.
AssetGroupActionForm::$entityType protected property The entity type.
AssetGroupActionForm::$entityTypeManager protected property The entity type manager.
AssetGroupActionForm::$tempStore protected property The tempstore factory.
AssetGroupActionForm::$user protected property The current user.
AssetGroupActionForm::buildForm public function Form constructor. Overrides ConfirmFormBase::buildForm
AssetGroupActionForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
AssetGroupActionForm::getCancelUrl public function Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface::getCancelUrl
AssetGroupActionForm::getConfirmText public function Returns a caption for the button that confirms the action. Overrides ConfirmFormBase::getConfirmText
AssetGroupActionForm::getDescription public function Returns additional text to display as a description. Overrides ConfirmFormBase::getDescription
AssetGroupActionForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
AssetGroupActionForm::getQuestion public function Returns the question to ask the user. Overrides ConfirmFormInterface::getQuestion
AssetGroupActionForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
AssetGroupActionForm::__construct public function Constructs an AssetGroupActionForm form object.
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
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.