class ExportForm in Term CSV Export Import 8.2

Class ExportForm.

@package Drupal\term_csv_export_import\Form

Hierarchy

• class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
  • class \Drupal\term_csv_export_import\Form\ExportForm

1 string reference to 'ExportForm'

term_csv_export_import.routing.yml in ./term_csv_export_import.routing.yml

term_csv_export_import.routing.yml

File

src/Form/ExportForm.php, line 15

Namespace

Drupal\term_csv_export_import\Form

class ExportForm extends FormBase {

  /**
   * Set a var to make stepthrough form.
   *
   * @var step
   */
  protected $step = 1;

  /**
   * Set a var for export values.
   *
   * @var getExport
   */
  protected $getExport = '';

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

  /**
   * {@inheritdoc}
   */
  protected $container;

  /**
   * {@inheritdoc}
   */
  public function __construct(ContainerInterface $container) {
    $this->container = $container;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container);
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    switch ($this->step) {
      case 1:
        $form['vocabulary'] = [
          '#type' => 'select',
          '#title' => $this
            ->t('Taxonomy'),
          '#options' => taxonomy_vocabulary_get_names(),
        ];
        $form['include_ids'] = [
          '#type' => 'checkbox',
          '#title' => $this
            ->t('Include Term Ids in export.'),
        ];
        $form['include_headers'] = [
          '#type' => 'checkbox',
          '#title' => $this
            ->t('Include Term Headers in export.'),
        ];
        $form['include_additional_fields'] = [
          '#type' => 'checkbox',
          '#title' => $this
            ->t('Include extra fields in export.'),
          '#description' => $this
            ->t('Note that fields are stringified using <a href="http://www.php.net/http_build_query">http_build_query</a>'),
        ];
        $form['submit'] = [
          '#type' => 'submit',
          '#value' => $this
            ->t('Export'),
        ];
        break;
      case 2:
        $form['input'] = [
          '#type' => 'textarea',
          '#title' => $this
            ->t('CSV Data'),
          '#description' => $this
            ->t('The formatted term data'),
          '#value' => $this->getExport,
        ];
        break;
    }
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $this->step++;
    $export = new ExportController($this->container
      ->get('entity_type.manager')
      ->getStorage('taxonomy_term'), $form_state
      ->getValue('vocabulary'));
    $this->getExport = $export
      ->execute($form_state
      ->getValue('include_ids'), $form_state
      ->getValue('include_headers'), $form_state
      ->getValue('include_additional_fields'));
    $form_state
      ->setRebuild();
  }

}

Members

Name	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
ExportForm::$container	protected	property
ExportForm::$getExport	protected	property	Set a var for export values.
ExportForm::$step	protected	property	Set a var to make stepthrough form.
ExportForm::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
ExportForm::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
ExportForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
ExportForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
ExportForm::__construct	public	function
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
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.