class ContactFormEditForm
Same name in other branches
- 9 core/modules/contact/src/ContactFormEditForm.php \Drupal\contact\ContactFormEditForm
- 10 core/modules/contact/src/ContactFormEditForm.php \Drupal\contact\ContactFormEditForm
- 11.x core/modules/contact/src/ContactFormEditForm.php \Drupal\contact\ContactFormEditForm
Base form for contact form edit forms.
@internal
Hierarchy
- class \Drupal\Core\Form\FormBase implements \Drupal\Core\Form\FormInterface, \Drupal\Core\DependencyInjection\ContainerInjectionInterface uses \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Routing\LinkGeneratorTrait, \Drupal\Core\Logger\LoggerChannelTrait, \Drupal\Core\Messenger\MessengerTrait, \Drupal\Core\Routing\RedirectDestinationTrait, \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\Routing\UrlGeneratorTrait
- class \Drupal\Core\Entity\EntityForm extends \Drupal\Core\Form\FormBase implements \Drupal\Core\Entity\EntityFormInterface
- class \Drupal\contact\ContactFormEditForm extends \Drupal\Core\Entity\EntityForm implements \Drupal\Core\DependencyInjection\ContainerInjectionInterface uses \Drupal\Core\Form\ConfigFormBaseTrait
- class \Drupal\Core\Entity\EntityForm extends \Drupal\Core\Form\FormBase implements \Drupal\Core\Entity\EntityFormInterface
Expanded class hierarchy of ContactFormEditForm
File
-
core/
modules/ contact/ src/ ContactFormEditForm.php, line 20
Namespace
Drupal\contactView source
class ContactFormEditForm extends EntityForm implements ContainerInjectionInterface {
use ConfigFormBaseTrait;
/**
* The email validator.
*
* @var \Drupal\Component\Utility\EmailValidatorInterface
*/
protected $emailValidator;
/**
* The path validator.
*
* @var \Drupal\Core\Path\PathValidatorInterface
*/
protected $pathValidator;
/**
* Constructs a new ContactFormEditForm.
*
* @param \Drupal\Component\Utility\EmailValidatorInterface $email_validator
* The email validator.
* @param \Drupal\Core\Path\PathValidatorInterface $path_validator
* The path validator service.
*/
public function __construct(EmailValidatorInterface $email_validator, PathValidatorInterface $path_validator) {
$this->emailValidator = $email_validator;
$this->pathValidator = $path_validator;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container) {
return new static($container->get('email.validator'), $container->get('path.validator'));
}
/**
* {@inheritdoc}
*/
protected function getEditableConfigNames() {
return [
'contact.settings',
];
}
/**
* {@inheritdoc}
*/
public function form(array $form, FormStateInterface $form_state) {
$form = parent::form($form, $form_state);
$contact_form = $this->entity;
$default_form = $this->config('contact.settings')
->get('default_form');
$form['label'] = [
'#type' => 'textfield',
'#title' => $this->t('Label'),
'#maxlength' => 255,
'#default_value' => $contact_form->label(),
'#description' => $this->t("Example: 'website feedback' or 'product information'."),
'#required' => TRUE,
];
$form['id'] = [
'#type' => 'machine_name',
'#default_value' => $contact_form->id(),
'#maxlength' => EntityTypeInterface::BUNDLE_MAX_LENGTH,
'#machine_name' => [
'exists' => '\\Drupal\\contact\\Entity\\ContactForm::load',
],
'#disabled' => !$contact_form->isNew(),
];
$form['recipients'] = [
'#type' => 'textarea',
'#title' => $this->t('Recipients'),
'#default_value' => implode(', ', $contact_form->getRecipients()),
'#description' => $this->t("Example: 'webmaster@example.com' or 'sales@example.com,support@example.com' . To specify multiple recipients, separate each email address with a comma."),
'#required' => TRUE,
];
$form['message'] = [
'#type' => 'textarea',
'#title' => $this->t('Message'),
'#default_value' => $contact_form->getMessage(),
'#description' => $this->t('The message to display to the user after submission of this form. Leave blank for no message.'),
];
$form['redirect'] = [
'#type' => 'path',
'#title' => $this->t('Redirect path'),
'#convert_path' => PathElement::CONVERT_NONE,
'#default_value' => $contact_form->getRedirectPath(),
'#description' => $this->t('Path to redirect the user to after submission of this form. For example, type "/about" to redirect to that page. Use a relative path with a slash in front.'),
];
$form['reply'] = [
'#type' => 'textarea',
'#title' => $this->t('Auto-reply'),
'#default_value' => $contact_form->getReply(),
'#description' => $this->t('Optional auto-reply. Leave empty if you do not want to send the user an auto-reply message.'),
];
$form['weight'] = [
'#type' => 'weight',
'#title' => $this->t('Weight'),
'#default_value' => $contact_form->getWeight(),
'#description' => $this->t('When listing forms, those with lighter (smaller) weights get listed before forms with heavier (larger) weights. Forms with equal weights are sorted alphabetically.'),
];
$form['selected'] = [
'#type' => 'checkbox',
'#title' => $this->t('Make this the default form'),
'#default_value' => $default_form === $contact_form->id(),
];
return $form;
}
/**
* {@inheritdoc}
*/
public function validateForm(array &$form, FormStateInterface $form_state) {
parent::validateForm($form, $form_state);
// Validate and each email recipient.
$recipients = explode(',', $form_state->getValue('recipients'));
foreach ($recipients as &$recipient) {
$recipient = trim($recipient);
if (!$this->emailValidator
->isValid($recipient)) {
$form_state->setErrorByName('recipients', $this->t('%recipient is an invalid email address.', [
'%recipient' => $recipient,
]));
}
}
$form_state->setValue('recipients', $recipients);
$redirect_url = $form_state->getValue('redirect');
if ($redirect_url && $this->pathValidator
->isValid($redirect_url)) {
if (mb_substr($redirect_url, 0, 1) !== '/') {
$form_state->setErrorByName('redirect', $this->t('The path should start with /.'));
}
}
}
/**
* {@inheritdoc}
*/
public function save(array $form, FormStateInterface $form_state) {
$contact_form = $this->entity;
$status = $contact_form->save();
$contact_settings = $this->config('contact.settings');
$edit_link = $this->entity
->toLink($this->t('Edit'))
->toString();
$view_link = $contact_form->toLink($contact_form->label(), 'canonical')
->toString();
if ($status == SAVED_UPDATED) {
$this->messenger()
->addStatus($this->t('Contact form %label has been updated.', [
'%label' => $view_link,
]));
$this->logger('contact')
->notice('Contact form %label has been updated.', [
'%label' => $contact_form->label(),
'link' => $edit_link,
]);
}
else {
$this->messenger()
->addStatus($this->t('Contact form %label has been added.', [
'%label' => $view_link,
]));
$this->logger('contact')
->notice('Contact form %label has been added.', [
'%label' => $contact_form->label(),
'link' => $edit_link,
]);
}
// Update the default form.
if ($form_state->getValue('selected')) {
$contact_settings->set('default_form', $contact_form->id())
->save();
}
elseif ($contact_settings->get('default_form') == $contact_form->id()) {
$contact_settings->set('default_form', NULL)
->save();
}
$form_state->setRedirectUrl($contact_form->toUrl('collection'));
}
}
Members
Title Sort descending | Deprecated | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|---|
ConfigFormBaseTrait::config | protected | function | Retrieves a configuration object. | |||
ContactFormEditForm::$emailValidator | protected | property | The email validator. | |||
ContactFormEditForm::$pathValidator | protected | property | The path validator. | |||
ContactFormEditForm::create | public static | function | Instantiates a new instance of this class. | Overrides FormBase::create | ||
ContactFormEditForm::form | public | function | Gets the actual form array to be built. | Overrides EntityForm::form | ||
ContactFormEditForm::getEditableConfigNames | protected | function | Gets the configuration names that will be editable. | Overrides ConfigFormBaseTrait::getEditableConfigNames | ||
ContactFormEditForm::save | public | function | Form submission handler for the 'save' action. | Overrides EntityForm::save | ||
ContactFormEditForm::validateForm | public | function | Form validation handler. | Overrides FormBase::validateForm | ||
ContactFormEditForm::__construct | public | function | Constructs a new ContactFormEditForm. | |||
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 | |||
EntityForm::$entity | protected | property | The entity being used by this form. | 11 | ||
EntityForm::$entityTypeManager | protected | property | The entity type manager. | 3 | ||
EntityForm::$moduleHandler | protected | property | The module handler service. | |||
EntityForm::$operation | protected | property | The name of the current operation. | |||
EntityForm::$privateEntityManager | private | property | The entity manager. | |||
EntityForm::actions | protected | function | Returns an array of supported actions for the current entity form. | 36 | ||
EntityForm::actionsElement | protected | function | Returns the action form element for the current entity form. | |||
EntityForm::afterBuild | public | function | Form element #after_build callback: Updates the entity with submitted data. | |||
EntityForm::buildEntity | public | function | Builds an updated entity object based upon the submitted form values. | Overrides EntityFormInterface::buildEntity | 3 | |
EntityForm::buildForm | public | function | Form constructor. | Overrides FormInterface::buildForm | 13 | |
EntityForm::copyFormValuesToEntity | protected | function | Copies top-level form values to entity properties | 9 | ||
EntityForm::getBaseFormId | public | function | Returns a string identifying the base form. | Overrides BaseFormIdInterface::getBaseFormId | 6 | |
EntityForm::getEntity | public | function | Gets the form entity. | Overrides EntityFormInterface::getEntity | ||
EntityForm::getEntityFromRouteMatch | public | function | Determines which entity will be used by this form from a RouteMatch object. | Overrides EntityFormInterface::getEntityFromRouteMatch | 3 | |
EntityForm::getFormId | public | function | Returns a unique string identifying the form. | Overrides FormInterface::getFormId | 12 | |
EntityForm::getOperation | public | function | Gets the operation identifying the form. | Overrides EntityFormInterface::getOperation | ||
EntityForm::init | protected | function | Initialize the form state and the entity before the first form build. | 3 | ||
EntityForm::prepareEntity | protected | function | Prepares the entity object before the form is built first. | 3 | ||
EntityForm::prepareInvokeAll | protected | function | Invokes the specified prepare hook variant. | |||
EntityForm::processForm | public | function | Process callback: assigns weights and hides extra fields. | |||
EntityForm::setEntity | public | function | Sets the form entity. | Overrides EntityFormInterface::setEntity | ||
EntityForm::setEntityManager | public | function | Sets the entity manager for this form. | Overrides EntityFormInterface::setEntityManager | ||
EntityForm::setEntityTypeManager | public | function | Sets the entity type manager for this form. | Overrides EntityFormInterface::setEntityTypeManager | ||
EntityForm::setModuleHandler | public | function | Sets the module handler for this form. | Overrides EntityFormInterface::setModuleHandler | ||
EntityForm::setOperation | public | function | Sets the operation for this form. | Overrides EntityFormInterface::setOperation | ||
EntityForm::submitForm | 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::submitForm | 20 | |
EntityForm::__get | public | function | ||||
EntityForm::__set | public | function | ||||
FormBase::$configFactory | protected | property | The config factory. | 3 | ||
FormBase::$requestStack | protected | property | The request stack. | 1 | ||
FormBase::$routeMatch | protected | property | The route match. | |||
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. | 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. | |||
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. | 17 | ||
MessengerTrait::messenger | public | function | Gets the messenger. | 17 | ||
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. | |||
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. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.