class EntityformTypeForm in Entityform 8.3
Form controller for entityform type forms.
Hierarchy
- class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\Core\Entity\EntityForm implements EntityFormInterface
- class \Drupal\entityform\EntityformTypeForm
- class \Drupal\Core\Entity\EntityForm implements EntityFormInterface
Expanded class hierarchy of EntityformTypeForm
1 file declares its use of EntityformTypeForm
- EntityformSubmission.php in src/
Entity/ EntityformSubmission.php - Definition of Drupal\entityform\Entity\EntityformSubmission.
File
- src/
EntityformTypeForm.php, line 19 - Contains \Drupal\entityform\EntityformTypeFormController.
Namespace
Drupal\entityformView source
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'));
}
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
EntityForm:: |
protected | property | The entity being used by this form. | 7 |
EntityForm:: |
protected | property | The entity type manager. | 3 |
EntityForm:: |
protected | property | The module handler service. | |
EntityForm:: |
protected | property | The name of the current operation. | |
EntityForm:: |
private | property | The entity manager. | |
EntityForm:: |
protected | function | Returns the action form element for the current entity form. | |
EntityForm:: |
public | function | Form element #after_build callback: Updates the entity with submitted data. | |
EntityForm:: |
public | function |
Builds an updated entity object based upon the submitted form values. Overrides EntityFormInterface:: |
2 |
EntityForm:: |
public | function |
Form constructor. Overrides FormInterface:: |
10 |
EntityForm:: |
protected | function | Copies top-level form values to entity properties | 7 |
EntityForm:: |
public | function |
Returns a string identifying the base form. Overrides BaseFormIdInterface:: |
5 |
EntityForm:: |
public | function |
Gets the form entity. Overrides EntityFormInterface:: |
|
EntityForm:: |
public | function |
Determines which entity will be used by this form from a RouteMatch object. Overrides EntityFormInterface:: |
1 |
EntityForm:: |
public | function |
Returns a unique string identifying the form. Overrides FormInterface:: |
10 |
EntityForm:: |
public | function |
Gets the operation identifying the form. Overrides EntityFormInterface:: |
|
EntityForm:: |
protected | function | Initialize the form state and the entity before the first form build. | 3 |
EntityForm:: |
protected | function | Prepares the entity object before the form is built first. | 3 |
EntityForm:: |
protected | function | Invokes the specified prepare hook variant. | |
EntityForm:: |
public | function | Process callback: assigns weights and hides extra fields. | |
EntityForm:: |
public | function |
Sets the form entity. Overrides EntityFormInterface:: |
|
EntityForm:: |
public | function |
Sets the entity manager for this form. Overrides EntityFormInterface:: |
|
EntityForm:: |
public | function |
Sets the entity type manager for this form. Overrides EntityFormInterface:: |
|
EntityForm:: |
public | function |
Sets the module handler for this form. Overrides EntityFormInterface:: |
|
EntityForm:: |
public | function |
Sets the operation for this form. Overrides EntityFormInterface:: |
|
EntityForm:: |
public | function |
This is the default entity object builder function. It is called before any
other submit handler to build the new entity object to be used by the
following submit handlers. At this point of the form workflow the entity is
validated and the form state… Overrides FormInterface:: |
17 |
EntityForm:: |
public | function | ||
EntityForm:: |
public | function | ||
EntityformTypeForm:: |
protected | function |
Returns an array of supported actions for the current entity form. Overrides EntityForm:: |
|
EntityformTypeForm:: |
public | function |
Gets the actual form array to be built. Overrides EntityForm:: |
|
EntityformTypeForm:: |
public | function |
Form submission handler for the 'save' action. Overrides EntityForm:: |
|
EntityformTypeForm:: |
public | function | ||
FormBase:: |
protected | property | The config factory. | 1 |
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. | 1 |
FormBase:: |
private | function | Returns the service container. | |
FormBase:: |
public static | function |
Instantiates a new instance of this class. Overrides ContainerInjectionInterface:: |
87 |
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. Overrides UrlGeneratorTrait:: |
|
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:: |
62 |
LinkGeneratorTrait:: |
protected | property | The link generator. | 1 |
LinkGeneratorTrait:: |
protected | function | Returns the link generator. | |
LinkGeneratorTrait:: |
protected | function | Renders a link to a route given a route name and its parameters. | |
LinkGeneratorTrait:: |
public | function | Sets the link generator service. | |
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. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
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. | 1 |
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. | |
UrlGeneratorTrait:: |
protected | property | The url generator. | |
UrlGeneratorTrait:: |
protected | function | Returns the URL generator service. | |
UrlGeneratorTrait:: |
public | function | Sets the URL generator service. | |
UrlGeneratorTrait:: |
protected | function | Generates a URL or path for a specific route based on the given parameters. |