You are here

abstract class GathercontentMultistepFormBase in GatherContent 8

Class GathercontentMultistepFormBase.

@package Drupal\gathercontent\Form

Hierarchy

Expanded class hierarchy of GathercontentMultistepFormBase

File

src/Form/GathercontentMultistepFormBase.php, line 18

Namespace

Drupal\gathercontent\Form
View source
abstract class GathercontentMultistepFormBase extends FormBase {

  /**
   * Drupal\Core\Entity\EntityManager definition.
   *
   * @var EntityManager
   */
  protected $entity_manager;

  /**
   * Drupal\Core\Datetime\DateFormatter definition.
   *
   * @var DateFormatter
   */
  protected $date_formatter;

  /**
   * @var \Drupal\user\PrivateTempStoreFactory
   */
  protected $tempStoreFactory;

  /**
   * @var \Drupal\Core\Entity\Query\QueryFactory
   */
  protected $entityQuery;

  /**
   * @var \Drupal\user\PrivateTempStore
   */
  protected $store;
  public function __construct(EntityManagerInterface $entity_manager, DateFormatterInterface $date_formatter, PrivateTempStoreFactory $temp_store_factory, QueryFactory $entityQuery) {
    $this->entity_manager = $entity_manager;
    $this->date_formatter = $date_formatter;
    $this->tempStoreFactory = $temp_store_factory;
    $this->entityQuery = $entityQuery;
    $this->store = $this->tempStoreFactory
      ->get('gathercontent_multistep_data');
  }
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('entity.manager'), $container
      ->get('date.formatter'), $container
      ->get('user.private_tempstore'), $container
      ->get('entity.query'));
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form = array();
    $form['actions']['#type'] = 'actions';
    $form['actions']['submit'] = array(
      '#type' => 'submit',
      '#value' => $this
        ->t('Submit'),
      '#button_type' => 'primary',
      '#weight' => 10,
    );
    return $form;
  }

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

  /**
   * Saves the data from the multistep form.
   */
  protected function saveData() {

    // Logic for saving data goes here...
    $this
      ->deleteStore([]);
    drupal_set_message($this
      ->t('The form has been saved.'));
  }

  /**
   * Helper method that removes all the keys from the store collection used for
   * the multistep form.
   *
   * @param array $keys
   *   Array of keys to delete.
   */
  protected function deleteStore(array $keys) {
    foreach ($keys as $key) {
      $this->store
        ->delete($key);
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
FormBase::$configFactory protected property The config factory. 1
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. 1
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. Overrides UrlGeneratorTrait::redirect
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 62
FormInterface::getFormId public function Returns a unique string identifying the form. 236
GathercontentMultistepFormBase::$date_formatter protected property Drupal\Core\Datetime\DateFormatter definition.
GathercontentMultistepFormBase::$entityQuery protected property
GathercontentMultistepFormBase::$entity_manager protected property Drupal\Core\Entity\EntityManager definition.
GathercontentMultistepFormBase::$store protected property
GathercontentMultistepFormBase::$tempStoreFactory protected property
GathercontentMultistepFormBase::buildForm public function Form constructor. Overrides FormInterface::buildForm 2
GathercontentMultistepFormBase::create public static function Instantiates a new instance of this class. Overrides FormBase::create
GathercontentMultistepFormBase::deleteStore protected function Helper method that removes all the keys from the store collection used for the multistep form.
GathercontentMultistepFormBase::saveData protected function Saves the data from the multistep form.
GathercontentMultistepFormBase::submitForm public function Form submission handler. Overrides FormInterface::submitForm 2
GathercontentMultistepFormBase::__construct public function
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
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. 29
MessengerTrait::messenger public function Gets the messenger. 29
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. 1
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.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.