class AssetMoveActionForm in farmOS 2.x
Provides an asset move confirmation form.
Hierarchy
- class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
- class \Drupal\Core\Form\ConfirmFormBase implements ConfirmFormInterface
- class \Drupal\farm_location\Form\AssetMoveActionForm
- class \Drupal\Core\Form\ConfirmFormBase implements ConfirmFormInterface
Expanded class hierarchy of AssetMoveActionForm
1 string reference to 'AssetMoveActionForm'
- farm_location.routing.yml in modules/
core/ location/ farm_location.routing.yml - modules/core/location/farm_location.routing.yml
File
- modules/
core/ location/ src/ Form/ AssetMoveActionForm.php, line 19
Namespace
Drupal\farm_location\FormView source
class AssetMoveActionForm 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 move.
*
* @var \Drupal\Core\Entity\EntityInterface[]
*/
protected $entities;
/**
* Constructs an AssetMoveActionForm 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_move_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_move_action_confirm_form';
}
/**
* {@inheritdoc}
*/
public function getQuestion() {
return $this
->formatPlural(count($this->entities), 'Are you sure you want to move this @item?', 'Are you sure you want to move 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('Move');
}
/**
* {@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['location'] = [
'#type' => 'entity_autocomplete',
'#title' => $this
->t('Location'),
'#target_type' => 'asset',
'#selection_handler' => 'views',
'#selection_settings' => [
'view' => [
'view_name' => 'farm_location_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 movement 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 activity log to move the assets.
if ($form_state
->getValue('confirm') && !empty($accessible_entities)) {
// Load location assets.
$locations = [];
$location_ids = array_column($form_state
->getValue('location', []), 'target_id');
if (!empty($location_ids)) {
$locations = $this->entityTypeManager
->getStorage('asset')
->loadMultiple($location_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);
$location_names = farm_log_asset_names_summary($locations);
$log_name = $this
->t('Move :assets to :locations', [
':assets' => $asset_names,
':locations' => $location_names,
]);
// Create the log.
$log = Log::create([
'name' => $log_name,
'type' => 'activity',
'timestamp' => $date
->getTimestamp(),
'asset' => $accessible_entities,
'is_movement' => TRUE,
'location' => $locations,
]);
// 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 move @count @item because you do not have the necessary permissions.', 'Could not move @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
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
AssetMoveActionForm:: |
protected | property | The assets to move. | |
AssetMoveActionForm:: |
protected | property | The entity type. | |
AssetMoveActionForm:: |
protected | property | The entity type manager. | |
AssetMoveActionForm:: |
protected | property | The tempstore factory. | |
AssetMoveActionForm:: |
protected | property | The current user. | |
AssetMoveActionForm:: |
public | function |
Form constructor. Overrides ConfirmFormBase:: |
|
AssetMoveActionForm:: |
public static | function |
Instantiates a new instance of this class. Overrides FormBase:: |
|
AssetMoveActionForm:: |
public | function |
Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface:: |
|
AssetMoveActionForm:: |
public | function |
Returns a caption for the button that confirms the action. Overrides ConfirmFormBase:: |
|
AssetMoveActionForm:: |
public | function |
Returns additional text to display as a description. Overrides ConfirmFormBase:: |
|
AssetMoveActionForm:: |
public | function |
Returns a unique string identifying the form. Overrides FormInterface:: |
|
AssetMoveActionForm:: |
public | function |
Returns the question to ask the user. Overrides ConfirmFormInterface:: |
|
AssetMoveActionForm:: |
public | function |
Form submission handler. Overrides FormInterface:: |
|
AssetMoveActionForm:: |
public | function | Constructs an AssetMoveActionForm form object. | |
ConfirmFormBase:: |
public | function |
Returns a caption for the link which cancels the action. Overrides ConfirmFormInterface:: |
2 |
ConfirmFormBase:: |
public | function |
Returns the internal name used to refer to the confirmation item. Overrides ConfirmFormInterface:: |
|
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
public | function | 2 | |
DependencySerializationTrait:: |
public | function | 2 | |
FormBase:: |
protected | property | The config factory. | 3 |
FormBase:: |
protected | property | The request stack. | 1 |
FormBase:: |
protected | property | The route match. | |
FormBase:: |
protected | function | Retrieves a configuration object. | |
FormBase:: |
protected | function | Gets the config factory for this form. | 3 |
FormBase:: |
private | function | Returns the service container. | |
FormBase:: |
protected | function | Gets the current user. | |
FormBase:: |
protected | function | Gets the request object. | |
FormBase:: |
protected | function | Gets the route match. | |
FormBase:: |
protected | function | Gets the logger for a specific channel. | |
FormBase:: |
protected | function | Returns a redirect response object for the specified route. | |
FormBase:: |
public | function | Resets the configuration factory. | |
FormBase:: |
public | function | Sets the config factory for this form. | |
FormBase:: |
public | function | Sets the request stack object to use. | |
FormBase:: |
public | function |
Form validation handler. Overrides FormInterface:: |
72 |
LoggerChannelTrait:: |
protected | property | The logger channel factory service. | |
LoggerChannelTrait:: |
protected | function | Gets the logger for a specific channel. | |
LoggerChannelTrait:: |
public | function | Injects the logger channel factory. | |
MessengerTrait:: |
protected | property | The messenger. | 27 |
MessengerTrait:: |
public | function | Gets the messenger. | 27 |
MessengerTrait:: |
public | function | Sets the messenger. | |
RedirectDestinationTrait:: |
protected | property | The redirect destination service. | 1 |
RedirectDestinationTrait:: |
protected | function | Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url. | |
RedirectDestinationTrait:: |
protected | function | Returns the redirect destination service. | |
RedirectDestinationTrait:: |
public | function | Sets the redirect destination service. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 4 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |