You are here

EntityformTypeForm.php in Entityform 8.3

Namespace

Drupal\entityform

File

src/EntityformTypeForm.php
View source
<?php

/**
 * @file
 * Contains \Drupal\entityform\EntityformTypeFormController.
 */
namespace Drupal\entityform;

use Drupal\Core\Entity\EntityForm;
use Drupal\entityform\Entity\EntityformType;
use Drupal\Component\Utility\String;
use Drupal\Core\Entity\EntityTypeInterface;
use Drupal\Core\Form\FormStateInterface;

/**
 * Form controller for entityform type forms.
 */
class EntityformTypeForm extends EntityForm {

  /**
   * {@inheritdoc}
   */
  public function form(array $form, FormStateInterface $form_state) {
    $form = parent::form($form, $form_state);

    // @todo Deal with default value logic and message from D7
    $default_value_message = '';
    $type = $this->entity;
    if ($this->operation == 'add') {
      $form['#title'] = String::checkPlain($this
        ->t('Add entityform type'));
    }
    elseif ($this->operation == 'edit') {
      $form['#title'] = $this
        ->t('Edit %name entityform type', array(
        '%name' => $type
          ->label(),
      ));
    }
    $entityform_settings = $type
      ->getModuleSettings('entityform');

    // Ensure default settings.
    $form['name'] = array(
      '#title' => t('Name'),
      '#type' => 'textfield',
      '#default_value' => $type->name,
      '#description' => t('The human-readable name of this entityform type. This text will be displayed as part of the list on the <em>Add new entityform</em> page. It is recommended that this name begin with a capital letter and contain only letters, numbers, and spaces. This name must be unique.'),
      '#required' => TRUE,
      '#size' => 30,
    );
    $form['type'] = array(
      '#type' => 'machine_name',
      '#default_value' => $type
        ->id(),
      '#maxlength' => EntityTypeInterface::BUNDLE_MAX_LENGTH,
      '#disabled' => $type
        ->isLocked(),
      '#machine_name' => array(
        //'exists' => 'node_type_load',
        'source' => array(
          'name',
        ),
      ),
      '#description' => t('A unique machine-readable name for this entityform type. It must only contain lowercase letters, numbers, and underscores. This name will be used for constructing the URL of the %entityform-add page, in which underscores will be converted into hyphens.', array(
        '%entityform-add' => t('Add new entityform type'),
      )),
    );
    $form['description'] = array(
      '#title' => t('Description'),
      '#type' => 'textarea',
      '#default_value' => $type->description,
      '#description' => t('Describe this entityform type. The text will be displayed on the <em>Add new entityform type</em> page.'),
    );
    $form['additional_settings'] = array(
      '#type' => 'vertical_tabs',
    );
    $form['submission'] = array(
      '#type' => 'details',
      '#title' => $this
        ->t('Submission form settings'),
      '#group' => 'additional_settings',
    );
    $form['submission']['help'] = array(
      '#type' => 'textarea',
      '#title' => $this
        ->t('Explanation or submission guidelines'),
      '#default_value' => $type->help,
      '#description' => t('This text will be displayed at the top of the page when creating or editing entityform type of this type.'),
    );

    //****************ACCESS FIELDSET SETTINGS *********************//
    $form['access'] = array(
      '#type' => 'details',
      '#title' => $this
        ->t('Access settings'),
      //'#collapsible' => TRUE,
      '#group' => 'additional_settings',
      '#weight' => -50,
    );
    $form['access']['form_status'] = array(
      '#type' => 'select',
      '#title' => $this
        ->t('Form status'),
      '#options' => array(
        EntityformType::STATUS_OPEN => $this
          ->t('Open for new submissions'),
        EntityformType::STATUS_CLOSED => $this
          ->t('Closed form new form submissions'),
      ),
      '#default_value' => empty($type->form_status) ? EntityFormType::STATUS_OPEN : $type->form_status,
      '#description' => t('Can users submit this form?  Open means the users can submit this form.  Closed means the user can not submit the form.'),
    );
    $roles = user_roles();
    $form['access']['roles'] = array(
      '#type' => 'checkboxes',
      '#title' => t('Roles'),
      '#options' => user_role_names(),
      //'#options' => array('0' => 'zero'),
      '#default_value' => empty($type->roles) ? array() : $type->roles,
      '#description' => t('Please select the Role(s) that can submit this form.'),
      '#required' => TRUE,
      '#multiple' => TRUE,
    );
    $form['access']['resubmit_action'] = array(
      '#type' => 'select',
      '#title' => t('Resubmit action'),
      '#options' => array(
        EntityformType::RESUBMIT_ACTION_NEW => t('Allow new submission'),
        EntityformType::RESUBMIT_ACTION_OLD => t('Edit old submission'),
        EntityformType::RESUBMIT_ACTION_DISALLOW => t("Don't allow"),
        EntityformType::RESUBMIT_ACTION_CONFIRM => t('Goto Confirm page'),
      ),
      '#default_value' => empty($type->resubmit_action) ? EntityformType::RESUBMIT_ACTION_NEW : $type->resubmit_action,
      '#description' => t('Action to take if logged in user has already submitted form.'),
    );

    //****************SUBMISSION PAGE FIELDSET SETTINGS *********************//
    $form['submission_page'] = array(
      '#type' => 'details',
      '#title' => $this
        ->t('Submission page settings'),
      '#group' => 'additional_settings',
      '#weight' => 20,
    );
    $form['submission_page']['preview_page'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Preview Page'),
      '#default_value' => $type->preview_page,
      '#description' => t('Show a Preview page.'),
    );
    $form['submission_page']['submission_page_title'] = array(
      '#type' => 'textfield',
      '#title' => $this
        ->t('Submission Page Title'),
      '#default_value' => empty($type->submission_page_title) ? '' : $type->submission_page_title,
      '#description' => t('Page title for correct submission.') . $default_value_message,
    );
    $form['submission_page']['submission_text'] = array(
      '#type' => 'text_format',
      '#title' => $labels['submission_text'],
      '#default_value' => empty($type->submission_text['value']) ? '' : $type->submission_text['value'],
      '#format' => empty($type->submission_text['format']) ? NULL : $type->submission_text['format'],
      '#description' => t('This text will be displayed to the user when a correct form is submitted.') . $default_value_message,
    );
    $form['submission_page']['submission_show_submitted'] = array(
      '#type' => 'checkbox',
      '#title' => t('Show submission information'),
      '#default_value' => !empty($type->submission_show_submitted),
      '#description' => t('Show submitted data on submission page?'),
    );
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  protected function actions(array $form, FormStateInterface $form_state) {
    $actions = parent::actions($form, $form_state);
    $actions['submit']['#value'] = t('Save entityform type');
    $actions['delete']['#value'] = t('Delete entityform type');

    //$actions['delete']['#access'] = $this->entity->access('delete');
    return $actions;
  }

  /**
   * {@inheritdoc}
   */
  public function validate(array $form, FormStateInterface $form_state) {
    parent::validate($form, $form_state);
    $id = trim($form_state
      ->getValue('type'));

    // '0' is invalid, since elsewhere we check it using empty().
    if ($id == '0') {
      $form_state
        ->setErrorByName('type', $this
        ->t("Invalid machine-readable name. Enter a name other than %invalid.", array(
        '%invalid' => $id,
      )));
    }
  }

  /**
   * {@inheritdoc}
   */
  public function save(array $form, FormStateInterface $form_state) {
    $type = $this->entity;
    $type->type = trim($type
      ->id());
    $type->name = trim($type->name);
    $status = $type
      ->save();
    $context = array(
      '%name' => $type
        ->label(),
    );
    if ($status == SAVED_UPDATED) {
      drupal_set_message(t('The Entityform type %name has been updated.', $context));
    }
    elseif ($status == SAVED_NEW) {
      drupal_set_message(t('The Entityform type %name has been added.', $context));
      $this
        ->logger('entityform')
        ->notice('Added Entityform type %name.', $context);
    }

    //$form_state['redirect'] = 'entityform.overview_types';
    $form_state
      ->setRedirectUrl($type
      ->urlInfo('collection'));
  }

}

Classes

Namesort descending Description
EntityformTypeForm Form controller for entityform type forms.