class ColorForm in Color API 8
Form handler for the Color add and edit 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\colorapi\Form\ColorForm
- class \Drupal\Core\Entity\EntityForm implements EntityFormInterface
Expanded class hierarchy of ColorForm
File
- src/
Form/ ColorForm.php, line 19
Namespace
Drupal\colorapi\FormView source
class ColorForm extends EntityForm {
/**
* The Typed Data manager.
*
* @var \Drupal\Core\TypedData\TypedDataManagerInterface
*/
protected $typedDataManager;
/**
* The current user.
*
* @var \Drupal\Core\Session\AccountProxyInterface
*/
protected $currentUser;
/**
* The module handeler service.
*
* @var \Drupal\Core\Extension\ModuleHandlerInterface
*/
protected $moduleHandler;
/**
* The Color API service.
*
* @var \Drupal\colorapi\DataType\ColorapiServiceInterface
*/
protected $colorapiService;
/**
* Constructs a ColorForm object.
*
* @param \Drupal\Core\Entity\EntityTypeManagerInterface $entityTypeManager
* The entityTypeManager.
* @param \Drupal\Core\TypedData\TypedDataManagerInterface $typedDataManager
* The Typed Data manager.
* @param \Drupal\Core\Session\AccountProxyInterface $currentUser
* The current user.
* @param \Drupal\Core\Extension\ModuleHandlerInterface $moduleHandler
* The module handler service.
* @param \Drupal\colorapi\DataType\ColorapiServiceInterface $colorapiService
* The Color API service.
*/
public function __construct(EntityTypeManagerInterface $entityTypeManager, TypedDataManagerInterface $typedDataManager, AccountProxyInterface $currentUser, ModuleHandlerInterface $moduleHandler, ColorapiServiceInterface $colorapiService) {
$this->entityTypeManager = $entityTypeManager;
$this->typedDataManager = $typedDataManager;
$this->currentUser = $currentUser;
$this->moduleHandler = $moduleHandler;
$this->colorapiService = $colorapiService;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container) {
return new static($container
->get('entity_type.manager'), $container
->get('typed_data_manager'), $container
->get('current_user'), $container
->get('module_handler'), $container
->get('colorapi.service'));
}
/**
* {@inheritdoc}
*/
public function form(array $form, FormStateInterface $form_state) {
$form = parent::form($form, $form_state);
$color_entity = $this->entity;
$form['label'] = [
'#type' => 'textfield',
'#title' => $this
->t('Label'),
'#maxlength' => 255,
'#default_value' => $color_entity
->label(),
'#description' => $this
->t("Label for the Color."),
'#required' => TRUE,
];
$form['id'] = [
'#type' => 'machine_name',
'#default_value' => $color_entity
->id(),
'#machine_name' => [
'exists' => [
$this,
'checkMachineName',
],
],
'#disabled' => !$color_entity
->isNew(),
];
$form['color'] = [
'#type' => 'textfield',
'#title' => $this
->t('Color'),
'#default_value' => $color_entity
->getHexadecimal(),
'#required' => TRUE,
'#description' => $this
->t('Enter the color in hexadecimal string format #XXXXXX where X is a hexadecimal character (0-9, a-f).'),
'#element_validate' => [
'::colorElementValidate',
],
];
if ($this->currentUser
->hasPermission('administer colors') && !$this->moduleHandler
->moduleExists('jquery_colorpicker')) {
$url = Url::fromUri('https://www.drupal.org/project/jquery_colorpicker');
$form['color']['#description'] .= '<br />' . $this
->t('Install the <a href=":url">JQuery Colorpicker module</a> to enable a color popup for this field.', [
':url' => $url
->toString(),
]);
}
return $form;
}
/**
* Custom element validation handler for the 'color' property.
*
* Creates a TypedDataAPI colorapi_color object to work with, setting it as
* the value for the element.
*/
public function colorElementValidate(array &$element, FormStateInterface $form_state) {
$hexadecimal_color = $form_state
->getValue('color');
if (!$this->colorapiService
->isValidHexadecimalColorString($hexadecimal_color)) {
$form_state
->setError($element, $this
->t('%value is not a valid hexadecimal color string. Hexadecimal color strings are in the format #XXXXXX where X is a hexadecimal character (0-9, a-f).', [
'%value' => $hexadecimal_color,
]));
}
}
/**
* {@inheritdoc}
*/
public function save(array $form, FormStateInterface $form_state) {
$color_entity =& $this->entity;
$status = $color_entity
->save();
if ($status) {
$this
->messenger()
->addStatus($this
->t('Saved the Color: %label.', [
'%label' => $color_entity
->label(),
]));
}
else {
$this
->messenger()
->addStatus($this
->t('The Color %label was not saved.', [
'%label' => $color_entity
->label(),
]));
}
$form_state
->setRedirect('entity.colorapi_color.collection');
}
/**
* Helper function to check whether the Color machine_name already exists.
*
* @param string $id
* The Entity machine name to check for existence.
*
* @return bool
* A boolean indicating whether or not an entity with the given machine name
* exists or not.
*/
public function checkMachineName($id) {
$entity = $this->entityTypeManager
->getStorage('colorapi_color')
->getQuery()
->condition('id', $id)
->execute();
return (bool) $entity;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ColorForm:: |
protected | property | The Color API service. | |
ColorForm:: |
protected | property | The current user. | |
ColorForm:: |
protected | property |
The module handeler service. Overrides EntityForm:: |
|
ColorForm:: |
protected | property | The Typed Data manager. | |
ColorForm:: |
public | function | Helper function to check whether the Color machine_name already exists. | |
ColorForm:: |
public | function | Custom element validation handler for the 'color' property. | |
ColorForm:: |
public static | function |
Instantiates a new instance of this class. Overrides FormBase:: |
|
ColorForm:: |
public | function |
Gets the actual form array to be built. Overrides EntityForm:: |
|
ColorForm:: |
public | function |
Form submission handler for the 'save' action. Overrides EntityForm:: |
|
ColorForm:: |
public | function | Constructs a ColorForm object. | |
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 name of the current operation. | |
EntityForm:: |
private | property | The entity manager. | |
EntityForm:: |
protected | function | Returns an array of supported actions for the current entity form. | 29 |
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:: |
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. |