class CropTypeForm in Crop API 8.2
Same name and namespace in other branches
- 8 src/Form/CropTypeForm.php \Drupal\crop\Form\CropTypeForm
Form controller for crop 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\crop\Form\CropTypeForm
- class \Drupal\Core\Entity\EntityForm implements EntityFormInterface
Expanded class hierarchy of CropTypeForm
File
- src/
Form/ CropTypeForm.php, line 13
Namespace
Drupal\crop\FormView source
class CropTypeForm extends EntityForm {
/**
* {@inheritdoc}
*/
public function form(array $form, FormStateInterface $form_state) {
$form = parent::form($form, $form_state);
$type = $this->entity;
$form['#title'] = $this->operation == 'add' ? $this
->t('Add crop type') : $this
->t('Edit %label crop type', [
'%label' => $type
->label(),
]);
$form['label'] = [
'#title' => $this
->t('Name'),
'#type' => 'textfield',
'#default_value' => $type->label,
'#description' => $this
->t('The human-readable name of this crop type. This name must be unique.'),
'#required' => TRUE,
'#size' => 30,
];
$form['id'] = [
'#type' => 'machine_name',
'#default_value' => $type
->id(),
'#machine_name' => [
'exists' => [
'\\Drupal\\crop\\Entity\\CropType',
'load',
],
'source' => [
'label',
],
],
// A crop type's machine name cannot be changed.
'#disabled' => !$type
->isNew(),
'#description' => $this
->t('A unique machine-readable name for this crop type. It must only contain lowercase letters, numbers, and underscores.'),
];
$form['description'] = [
'#title' => $this
->t('Description'),
'#type' => 'textarea',
'#default_value' => $type->description,
'#description' => $this
->t('Describe this crop type.'),
];
$form['aspect_ratio'] = [
'#title' => $this
->t('Aspect Ratio'),
'#type' => 'textfield',
'#default_value' => $type->aspect_ratio,
'#attributes' => [
'placeholder' => 'W:H',
],
'#description' => $this
->t('Set an aspect ratio <b>eg: 16:9</b> or leave this empty for arbitrary aspect ratio'),
];
$form['soft_limit'] = [
'#type' => 'fieldset',
'#title' => $this
->t('Soft limit'),
'#description' => $this
->t('Define crop size soft limit. Warning will be displayed if crop smaller than that is selected.'),
];
$form['soft_limit']['soft_limit_width'] = [
'#type' => 'number',
'#title' => $this
->t('Width'),
'#default_value' => $type->soft_limit_width,
'#description' => $this
->t('Limit for width.'),
'#size' => 60,
'#field_suffix' => 'px',
'#min' => 0,
];
$form['soft_limit']['soft_limit_height'] = [
'#type' => 'number',
'#title' => $this
->t('Height'),
'#default_value' => $type->soft_limit_height,
'#description' => $this
->t('Limit for height.'),
'#size' => 60,
'#field_suffix' => 'px',
'#min' => 0,
];
$form['hard_limit'] = [
'#type' => 'fieldset',
'#title' => $this
->t('Hard limit'),
'#description' => $this
->t('Define crop size hard limit. User is not allowed to make a smaller selection than defined here.'),
];
$form['hard_limit']['hard_limit_width'] = [
'#type' => 'number',
'#title' => $this
->t('Width'),
'#default_value' => $type->hard_limit_width,
'#description' => $this
->t('Limit for width'),
'#size' => 60,
'#field_suffix' => 'px',
'#min' => 0,
];
$form['hard_limit']['hard_limit_height'] = [
'#type' => 'number',
'#title' => $this
->t('Height'),
'#default_value' => $type->hard_limit_height,
'#description' => $this
->t('Limit for height.'),
'#size' => 60,
'#field_suffix' => 'px',
'#min' => 0,
];
return $form;
}
/**
* {@inheritdoc}
*/
protected function actions(array $form, FormStateInterface $form_state) {
$actions = parent::actions($form, $form_state);
$actions['submit']['#value'] = $this
->t('Save crop type');
$actions['delete']['#value'] = $this
->t('Delete crop type');
return $actions;
}
/**
* {@inheritdoc}
*/
public function validateForm(array &$form, FormStateInterface $form_state) {
parent::validateForm($form, $form_state);
/** @var \Drupal\crop\Entity\CropType $entity */
$entity = $this
->buildEntity($form, $form_state);
$violations = $entity
->validate();
$this
->flagViolations($violations, $form, $form_state);
}
/**
* Flags violations for the current form.
*
* @param \Symfony\Component\Validator\ConstraintViolationListInterface $violations
* The violations to flag.
* @param array $form
* A nested array of form elements comprising the form.
* @param \Drupal\Core\Form\FormStateInterface $form_state
* The current state of the form.
*/
protected function flagViolations(ConstraintViolationListInterface $violations, array $form, FormStateInterface $form_state) {
// Manually flag violations of fields not handled by the form display.
foreach ($violations
->getIterator() as $violation) {
if ($violation
->getPropertyPath() == 'aspect_ratio') {
$form_state
->setErrorByName('aspect_ratio', $violation
->getMessage());
}
if ($violation
->getPropertyPath() == 'id') {
$form_state
->setErrorByName('id', $violation
->getMessage());
}
}
}
/**
* {@inheritdoc}
*/
public function save(array $form, FormStateInterface $form_state) {
$type = $this->entity;
$type->id = trim($type
->id());
$type->label = trim($type->label);
$type->aspect_ratio = trim($type->aspect_ratio);
$status = $type
->save();
$t_args = [
'%name' => $type
->label(),
];
if ($status == SAVED_UPDATED) {
$this
->messenger()
->addMessage($this
->t('The crop type %name has been updated.', $t_args));
}
elseif ($status == SAVED_NEW) {
$this
->messenger()
->addMessage($this
->t('The crop type %name has been added.', $t_args));
$context = array_merge($t_args, [
'link' => Link::createFromRoute($this
->t('View'), 'crop.overview_types')
->toString(),
]);
$this
->logger('crop')
->notice('Added crop type %name.', $context);
}
$form_state
->setRedirect('crop.overview_types');
}
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
CropTypeForm:: |
protected | function |
Returns an array of supported actions for the current entity form. Overrides EntityForm:: |
|
CropTypeForm:: |
protected | function | Flags violations for the current form. | |
CropTypeForm:: |
public | function |
Gets the actual form array to be built. Overrides EntityForm:: |
|
CropTypeForm:: |
public | function |
Form submission handler for the 'save' action. Overrides EntityForm:: |
|
CropTypeForm:: |
public | function |
Form validation handler. Overrides FormBase:: |
|
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 | ||
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. | |
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. |