class ShortcutSetForm
Same name and namespace in other branches
- 11.x core/modules/shortcut/src/ShortcutSetForm.php \Drupal\shortcut\ShortcutSetForm
- 10 core/modules/shortcut/src/ShortcutSetForm.php \Drupal\shortcut\ShortcutSetForm
- 9 core/modules/shortcut/src/ShortcutSetForm.php \Drupal\shortcut\ShortcutSetForm
- 8.9.x core/modules/shortcut/src/ShortcutSetForm.php \Drupal\shortcut\ShortcutSetForm
Form handler for the shortcut set entity 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\Htmx\HtmxRequestInfoTrait, \Drupal\Core\Logger\LoggerChannelTrait, \Drupal\Core\Messenger\MessengerTrait, \Drupal\Core\Routing\RedirectDestinationTrait, \Drupal\Core\StringTranslation\StringTranslationTrait
- class \Drupal\Core\Entity\EntityForm implements \Drupal\Core\Entity\EntityFormInterface extends \Drupal\Core\Form\FormBase
- class \Drupal\Core\Entity\BundleEntityFormBase extends \Drupal\Core\Entity\EntityForm
- class \Drupal\shortcut\ShortcutSetForm extends \Drupal\Core\Entity\BundleEntityFormBase
- class \Drupal\Core\Entity\BundleEntityFormBase extends \Drupal\Core\Entity\EntityForm
- class \Drupal\Core\Entity\EntityForm implements \Drupal\Core\Entity\EntityFormInterface extends \Drupal\Core\Form\FormBase
Expanded class hierarchy of ShortcutSetForm
1 file declares its use of ShortcutSetForm
- ShortcutSet.php in core/
modules/ shortcut/ src/ Entity/ ShortcutSet.php
File
-
core/
modules/ shortcut/ src/ ShortcutSetForm.php, line 13
Namespace
Drupal\shortcutView source
class ShortcutSetForm extends BundleEntityFormBase {
/**
* {@inheritdoc}
*/
public function form(array $form, FormStateInterface $form_state) {
$form = parent::form($form, $form_state);
$entity = $this->entity;
$form['label'] = [
'#type' => 'textfield',
'#title' => $this->t('Set name'),
'#description' => $this->t('The new set is created by copying links from your default shortcut set.'),
'#required' => TRUE,
'#default_value' => $entity->label(),
];
$form['id'] = [
'#type' => 'machine_name',
'#description' => $this->t('A unique machine-readable name. Can only contain lowercase letters, numbers, and hyphens.'),
'#machine_name' => [
'exists' => '\\Drupal\\shortcut\\Entity\\ShortcutSet::load',
'source' => [
'label',
],
'replace_pattern' => '[^a-z0-9-]+',
'replace' => '-',
],
'#default_value' => $entity->id(),
// This id could be used for menu name.
'#maxlength' => 23,
];
$form['actions']['submit']['#value'] = $this->t('Create new set');
return $this->protectBundleIdElement($form);
}
/**
* {@inheritdoc}
*/
public function save(array $form, FormStateInterface $form_state) {
$entity = $this->entity;
$is_new = !$entity->getOriginalId();
$entity->save();
if ($is_new) {
$this->messenger()
->addStatus($this->t('The %set_name shortcut set has been created. You can edit it from this page.', [
'%set_name' => $entity->label(),
]));
}
else {
$this->messenger()
->addStatus($this->t('Updated set name to %set-name.', [
'%set-name' => $entity->label(),
]));
}
$form_state->setRedirectUrl($this->entity
->toUrl('customize-form'));
}
}
Members
| Title Sort descending | Modifiers | Object type | Summary | Overriden Title |
|---|---|---|---|---|
| BundleEntityFormBase::protectBundleIdElement | protected | function | Protects the bundle entity's ID property's form element against changes. | |
| 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 | ||
| DependencySerializationTrait::__wakeup | public | function | ||
| EntityForm::$entity | protected | property | The entity being used by this form. | |
| EntityForm::$entityTypeManager | protected | property | The entity type manager. | |
| EntityForm::$moduleHandler | protected | property | The module handler service. | |
| EntityForm::$operation | protected | property | The name of the current operation. | |
| EntityForm::actions | protected | function | Returns an array of supported actions for the current entity form. | |
| 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 | ||
| EntityForm::buildForm | public | function | ||
| EntityForm::copyFormValuesToEntity | protected | function | Copies top-level form values to entity properties. | |
| EntityForm::getBaseFormId | public | function | ||
| EntityForm::getCallableFromDefinition | protected | function | Gets a callable from a string or array definition if possible. | |
| EntityForm::getEntity | public | function | ||
| EntityForm::getEntityFromRouteMatch | public | function | ||
| EntityForm::getFormId | public | function | ||
| EntityForm::getOperation | public | function | ||
| EntityForm::init | protected | function | Initialize the form state and the entity before the first form build. | |
| EntityForm::prepareEntity | protected | function | Prepares the entity object before the form is built first. | |
| 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 | ||
| EntityForm::setEntityTypeManager | public | function | ||
| EntityForm::setModuleHandler | public | function | ||
| EntityForm::setOperation | public | function | ||
| 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⦠|
|
| FormBase::$configFactory | protected | property | The config factory. | |
| FormBase::$requestStack | protected | property | The request stack. | |
| 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. | |
| FormBase::container | private | function | Returns the service container. | |
| FormBase::create | public static | function | ||
| 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. | |
| 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 | ||
| HtmxRequestInfoTrait::getHtmxCurrentUrl | protected | function | Retrieves the URL of the requesting page from an HTMX request header. | |
| HtmxRequestInfoTrait::getHtmxPrompt | protected | function | Retrieves the prompt from an HTMX request header. | |
| HtmxRequestInfoTrait::getHtmxTarget | protected | function | Retrieves the target identifier from an HTMX request header. | |
| HtmxRequestInfoTrait::getHtmxTrigger | protected | function | Retrieves the trigger identifier from an HTMX request header. | |
| HtmxRequestInfoTrait::getHtmxTriggerName | protected | function | Retrieves the trigger name from an HTMX request header. | |
| HtmxRequestInfoTrait::isHtmxBoosted | protected | function | Determines if the request is boosted by HTMX. | |
| HtmxRequestInfoTrait::isHtmxHistoryRestoration | protected | function | Determines if if the request is for history restoration. | |
| HtmxRequestInfoTrait::isHtmxRequest | protected | function | Determines if the request is sent by HTMX. | |
| 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. | |
| MessengerTrait::messenger | public | function | Gets the messenger. | |
| MessengerTrait::setMessenger | public | function | Sets the messenger. | |
| RedirectDestinationTrait::$redirectDestination | protected | property | The redirect destination service. | |
| 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. | |
| ShortcutSetForm::form | public | function | Gets the actual form array to be built. | Overrides EntityForm::form |
| ShortcutSetForm::save | public | function | Form submission handler for the 'save' action. | Overrides EntityForm::save |
| 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. | |
| StringTranslationTrait::t | protected | function | Translates a string to the current language or to a given language. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.