class LayoutOptionForm in Bootstrap Layout Builder 1.x
Same name and namespace in other branches
- 2.x src/Form/LayoutOptionForm.php \Drupal\bootstrap_layout_builder\Form\LayoutOptionForm
Form handler for the layout option entity forms.
@internal
Hierarchy
- class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
- class \Drupal\Core\Entity\EntityForm implements EntityFormInterface
- class \Drupal\bootstrap_layout_builder\Form\LayoutOptionForm implements ContainerInjectionInterface
- class \Drupal\Core\Entity\EntityForm implements EntityFormInterface
Expanded class hierarchy of LayoutOptionForm
File
- src/
Form/ LayoutOptionForm.php, line 18
Namespace
Drupal\bootstrap_layout_builder\FormView source
class LayoutOptionForm extends EntityForm implements ContainerInjectionInterface {
/**
* The access manager service.
*
* @var \\Drupal\Core\Routing\CurrentRouteMatch
*/
protected $routeMatch;
/**
* The entity type manager.
*
* @var \Drupal\Core\Entity\EntityTypeManagerInterface
*/
protected $entityTypeManager;
/**
* The messenger.
*
* @var \Drupal\Core\Messenger\MessengerInterface
*/
protected $messenger;
/**
* Constructs a BootstrapLayoutBuilderBreakpointsForm object.
*
* @param \Drupal\Core\Routing\CurrentRouteMatch $route_match
* The route match service.
* @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
* The entity type manager.
* @param \Drupal\Core\Messenger\MessengerInterface $messenger
* The messenger.
*/
public function __construct(CurrentRouteMatch $route_match, EntityTypeManagerInterface $entity_type_manager, MessengerInterface $messenger) {
$this->routeMatch = $route_match;
$this->entityTypeManager = $entity_type_manager;
$this->messenger = $messenger;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container) {
return new static($container
->get('current_route_match'), $container
->get('entity_type.manager'), $container
->get('messenger'));
}
/**
* The entity being used by this form.
*
* @var \Drupal\bootstrap_layout_builder\LayoutOptionInterface
*/
protected $entity;
/**
* {@inheritdoc}
*/
public function form(array $form, FormStateInterface $form_state) {
$form = parent::form($form, $form_state);
/** @var \Drupal\bootstrap_layout_builder\LayoutInterface $layout */
$option = $this->entity;
$form['label'] = [
'#type' => 'textfield',
'#title' => $this
->t('Label'),
'#maxlength' => 255,
'#default_value' => $option
->label(),
'#required' => TRUE,
];
$form['id'] = [
'#type' => 'machine_name',
'#default_value' => $option
->id(),
'#machine_name' => [
'exists' => '\\Drupal\\bootstrap_layout_builder\\Entity\\LayoutOption::load',
],
'#disabled' => !$option
->isNew(),
];
$form['structure'] = [
'#type' => 'textfield',
'#title' => $this
->t('Structure'),
'#maxlength' => 255,
'#default_value' => $option
->getStructure() ?: '',
'#description' => $this
->t('Add numbers seperated by space; if the number of columns at this layout is two and you are using bootstrap 12 Grid system<br/> this field must be two numbers at the sum of them sould equal 12. eg: <b>6 6</b> or <b>8 4</b> ...etc.'),
'#required' => TRUE,
];
$breakpoints = [];
$blb_breakpoint = $this->entityTypeManager
->getStorage('blb_breakpoint')
->getQuery()
->sort('weight', 'ASC')
->execute();
foreach ($blb_breakpoint as $breakpoint_id) {
$breakpoint_entity = $this->entityTypeManager
->getStorage('blb_breakpoint')
->load($breakpoint_id);
$breakpoints[$breakpoint_id] = $breakpoint_entity
->label();
}
$form['breakpoints'] = [
'#title' => $this
->t('Breakpoints'),
'#type' => 'checkboxes',
'#description' => $this
->t('Select which breakpoints uses this layout option'),
'#options' => $breakpoints,
'#default_value' => $option
->getBreakpointsIds() ?: [],
];
return $form;
}
/**
* {@inheritdoc}
*/
public function validateForm(array &$form, FormStateInterface $form_state) {
$layout_id = $this->routeMatch
->getParameter('blb_layout');
if ($layout_id) {
$layout = $this->entity
->getLayoutById($layout_id);
}
else {
$layout = $this->entity
->getLayout();
}
$structure = $form_state
->getValue('structure');
$structure = explode(' ', $structure);
$invalid_structure = FALSE;
// Make sure that all items are numbers.
foreach ($structure as $col) {
if (!is_numeric($col)) {
$invalid_structure = TRUE;
break;
}
}
// Check the number of colmuns and the sum of the structure.
if (count($structure) != $layout
->getNumberOfColumns() || array_sum($structure) != 12) {
$invalid_structure = TRUE;
}
if ($invalid_structure) {
$form_state
->setErrorByName('structure', $this
->t('Structure must be @cols numbers seperated by space and the sum of these numbers must equal 12!', [
'@cols' => $layout
->getNumberOfColumns(),
]));
}
}
/**
* {@inheritdoc}
*/
public function save(array $form, FormStateInterface $form_state) {
$layout_id = '';
if ($this->routeMatch
->getParameters()
->has('blb_layout')) {
$layout_id = $this->routeMatch
->getParameter('blb_layout');
}
$entity = $this->entity;
if ($layout_id) {
$entity
->setLayoutId($layout_id);
}
$status = $entity
->save();
if ($status == SAVED_UPDATED) {
$layout_id = $entity
->getLayoutId();
$message = $this
->t('The layout option @label has been updated.', [
'@label' => $entity
->label(),
]);
}
else {
$message = $this
->t('Added a layout option for @label.', [
'@label' => $entity
->label(),
]);
}
$this
->messenger()
->addStatus($message);
$form_state
->setRedirect('entity.blb_layout.options_form', [
'blb_layout' => $layout_id,
]);
}
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
public | function | 2 | |
DependencySerializationTrait:: |
public | function | 2 | |
EntityForm:: |
protected | property | The module handler service. | |
EntityForm:: |
protected | property | The name of the current operation. | |
EntityForm:: |
protected | function | Returns an array of supported actions for the current entity form. | 35 |
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:: |
3 |
EntityForm:: |
public | function |
Form constructor. Overrides FormInterface:: |
13 |
EntityForm:: |
protected | function | Copies top-level form values to entity properties. | 9 |
EntityForm:: |
public | function |
Returns a string identifying the base form. Overrides BaseFormIdInterface:: |
6 |
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:: |
3 |
EntityForm:: |
public | function |
Returns a unique string identifying the form. Overrides FormInterface:: |
12 |
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 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:: |
20 |
FormBase:: |
protected | property | The config factory. | 3 |
FormBase:: |
protected | property | The request stack. | 1 |
FormBase:: |
protected | function | Retrieves a configuration object. | |
FormBase:: |
protected | function | Gets the config factory for this form. | 3 |
FormBase:: |
private | function | Returns the service container. | |
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. | |
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. | |
LayoutOptionForm:: |
protected | property |
The entity being used by this form. Overrides EntityForm:: |
|
LayoutOptionForm:: |
protected | property |
The entity type manager. Overrides EntityForm:: |
|
LayoutOptionForm:: |
protected | property |
The messenger. Overrides MessengerTrait:: |
|
LayoutOptionForm:: |
protected | property |
The access manager service. Overrides FormBase:: |
|
LayoutOptionForm:: |
public static | function |
Instantiates a new instance of this class. Overrides FormBase:: |
|
LayoutOptionForm:: |
public | function |
Gets the actual form array to be built. Overrides EntityForm:: |
|
LayoutOptionForm:: |
public | function |
Form submission handler for the 'save' action. Overrides EntityForm:: |
|
LayoutOptionForm:: |
public | function |
Form validation handler. Overrides FormBase:: |
|
LayoutOptionForm:: |
public | function | Constructs a BootstrapLayoutBuilderBreakpointsForm object. | |
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:: |
public | function | Gets the messenger. | 27 |
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. | 4 |
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. |