class AssetAddLogActionForm in farmOS 2.x

Provides an asset add log 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_log\Form\AssetAddLogActionForm

Expanded class hierarchy of AssetAddLogActionForm

1 string reference to 'AssetAddLogActionForm'

farm_log.routing.yml in modules/core/log/farm_log.routing.yml: modules/core/log/farm_log.routing.yml

File

modules/core/log/src/Form/AssetAddLogActionForm.php, line 17

Namespace

Drupal\farm_log\Form

View source

class AssetAddLogActionForm 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 create logs for.
   *
   * @var \Drupal\Core\Entity\EntityInterface[]
   */
  protected $entities;

  /**
   * Constructs an AssetAddLogActionForm 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_add_log_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_add_log_action_confirm_form';
  }

  /**
   * {@inheritdoc}
   */
  public function getQuestion() {
    return $this
      ->formatPlural(count($this->entities), 'Are you sure you want to add a log referencing this @item?', 'Are you sure you want to add a log referencing 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('asset');
    $this->entities = $this->tempStore
      ->get($this->user
      ->id());
    if (empty($this->entityType) || empty($this->entities)) {
      return new RedirectResponse($this
        ->getCancelUrl()
        ->setAbsolute()
        ->toString());
    }

    // Build list of log type options.
    // Limit to log types the user has access to create.
    $log_types = array_filter($this->entityTypeManager
      ->getStorage('log_type')
      ->loadMultiple(), function ($log_type) {
      return $log_type
        ->access('create', $this
        ->currentUser());
    });
    $log_type_options = array_map(function ($log_type) {
      return $log_type
        ->label();
    }, $log_types);
    $form['log_type'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Log type'),
      '#description' => $this
        ->t('Select the type of log to create.'),
      '#options' => $log_type_options,
      '#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('view', $this
        ->currentUser())) {
        $inaccessible_entities[] = $entity;
        continue;
      }
      $accessible_entities[] = $entity;
    }

    // Default redirect url.
    $redirect_url = $this
      ->getCancelUrl();
    if (!empty($form_state
      ->getValue('confirm')) && !empty($accessible_entities)) {
      $log_type = $form_state
        ->getValue('log_type');
      if (!empty($log_type)) {

        // If a destination query param is set, save it and remove it.
        // First we need to redirect to the /log/add/{log_type} form.
        $destination = $this
          ->getCancelUrl()
          ->setAbsolute()
          ->toString();
        if ($this
          ->getRequest()->query
          ->has('destination')) {
          $destination = $this
            ->getRequest()->query
            ->get('destination');
          $this
            ->getRequest()->query
            ->remove('destination');
        }

        // Build list of asset ids.
        $asset_ids = array_map(function ($asset) {
          return $asset
            ->id();
        }, $accessible_entities);

        // Build query params to include in the redirect.
        $query_params = [
          'destination' => $destination,
          'asset' => $asset_ids,
        ];
        $redirect_url = Url::fromRoute('entity.log.add_form', [
          'log_type' => $log_type,
        ], [
          'query' => $query_params,
        ]);
      }
    }
    $this->tempStore
      ->delete($this
      ->currentUser()
      ->id());
    $form_state
      ->setRedirectUrl($redirect_url);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AssetAddLogActionForm::$entities	protected	property	The assets to create logs for.
AssetAddLogActionForm::$entityType	protected	property	The entity type.
AssetAddLogActionForm::$entityTypeManager	protected	property	The entity type manager.
AssetAddLogActionForm::$tempStore	protected	property	The tempstore factory.
AssetAddLogActionForm::$user	protected	property	The current user.
AssetAddLogActionForm::buildForm	public	function	Form constructor. Overrides ConfirmFormBase::buildForm
AssetAddLogActionForm::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
AssetAddLogActionForm::getCancelUrl	public	function	Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface::getCancelUrl
AssetAddLogActionForm::getConfirmText	public	function	Returns a caption for the button that confirms the action. Overrides ConfirmFormBase::getConfirmText
AssetAddLogActionForm::getDescription	public	function	Returns additional text to display as a description. Overrides ConfirmFormBase::getDescription
AssetAddLogActionForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
AssetAddLogActionForm::getQuestion	public	function	Returns the question to ask the user. Overrides ConfirmFormInterface::getQuestion
AssetAddLogActionForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
AssetAddLogActionForm::__construct	public	function	Constructs an AssetAddLogActionForm 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.

You are here

class AssetAddLogActionForm in farmOS 2.x

Hierarchy

File

Namespace

Members

API Navigation