class MaestroValidityCheck in Maestro 3.x
Same name and namespace in other branches
- 8.2 modules/maestro_template_builder/src/Form/MaestroValidityCheck.php \Drupal\maestro_template_builder\Form\MaestroValidityCheck
Hierarchy
- class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
- class \Drupal\maestro_template_builder\Form\MaestroValidityCheck
Expanded class hierarchy of MaestroValidityCheck
1 string reference to 'MaestroValidityCheck'
- maestro_template_builder.routing.yml in modules/
maestro_template_builder/ maestro_template_builder.routing.yml - modules/maestro_template_builder/maestro_template_builder.routing.yml
File
- modules/
maestro_template_builder/ src/ Form/ MaestroValidityCheck.php, line 16
Namespace
Drupal\maestro_template_builder\FormView source
class MaestroValidityCheck extends FormBase {
/**
* {@inheritdoc}
*/
public function getFormId() {
return 'template_validity_check';
}
/**
* {@inheritdoc}
*/
public function validateForm(array &$form, FormStateInterface $form_state) {
// Everything in the base form is mandatory. nothing really to check here.
}
/**
* {@inheritdoc}
*/
public function cancelForm(array &$form, FormStateInterface $form_state) {
// We cancel the modal dialog by first sending down the form's error state as the cancel is a submit.
// we then close the modal.
$response = new AjaxResponse();
$form['status_messages'] = [
'#type' => 'status_messages',
'#weight' => -10,
];
$items = MaestroEngine::performTemplateValidityCheck($form_state
->getValue('template_machine_name'));
if (count($items['failures']) > 0) {
$response
->addCommand(new FireJavascriptCommand('signalValidationRequired', []));
}
else {
$response
->addCommand(new FireJavascriptCommand('turnOffValidationRequired', []));
}
$response
->addCommand(new HtmlCommand('#template-validity-check', $form));
$response
->addCommand(new CloseModalDialogCommand());
return $response;
}
/**
* {@inheritdoc}
*/
public function submitForm(array &$form, FormStateInterface $form_state) {
$response = new AjaxResponse();
$response
->addCommand(new CloseModalDialogCommand());
return $response;
}
/**
* Ajax callback for add-new-form button click.
*/
public function buildForm(array $form, FormStateInterface $form_state, $templateMachineName = '') {
$template = MaestroEngine::getTemplate($templateMachineName);
// Need to validate this template to ensure that it exists.
if ($template == NULL) {
$form = [
'#title' => $this
->t('Error!'),
'#markup' => $this
->t("The template you are attempting to add a task to doesn't exist"),
];
return $form;
}
$items = MaestroEngine::performTemplateValidityCheck($templateMachineName);
$form = [
'#title' => $this
->t('Validity Check'),
];
// Failures.
if (count($items['failures'])) {
$form['#prefix'] = '<div id="template-validity-check" class="messages messages--error">';
foreach ($items['failures'] as $item) {
$form['#prefix'] .= '<div class="template-validity-check-issue">';
$form['#prefix'] .= '<span class="template-validity-check-label">' . $this
->t('Task ID') . ': </span>' . $item['taskID'] . "<br>";
$form['#prefix'] .= '<span class="template-validity-check-label">' . $this
->t('Task Label') . ': </span>' . $item['taskLabel'] . "<br>";
$form['#prefix'] .= '<span class="template-validity-check-label">' . $this
->t('Failure Note') . ': </span>' . $item['reason'] . "<br>";
$form['#prefix'] .= '</div>';
}
$form['#prefix'] .= '</div>';
}
else {
$form['#prefix'] = '<div id="template-validity-check" class="messages messages--status">' . $this
->t('Validity Check Passed') . "</div>";
}
// Information.
if (count($items['information'])) {
$form['#prefix'] .= '<div id="template-validity-check-information" class="messages messages--warning">';
foreach ($items['information'] as $item) {
$form['#prefix'] .= '<div class="template-validity-check-issue">';
$form['#prefix'] .= '<span class="template-validity-check-label">' . $this
->t('Task ID') . ': </span>' . $item['taskID'] . "<br>";
$form['#prefix'] .= '<span class="template-validity-check-label">' . $this
->t('Task Label') . ': </span>' . $item['taskLabel'] . "<br>";
$form['#prefix'] .= '<span class="template-validity-check-label">' . $this
->t('Information Note') . ': </span>' . $item['reason'] . "<br>";
$form['#prefix'] .= '</div>';
}
$form['#prefix'] .= '</div>';
}
$form['template_machine_name'] = [
'#type' => 'hidden',
'#default_value' => $templateMachineName,
];
$form['actions']['cancel'] = [
'#type' => 'button',
'#value' => $this
->t('Save Template Validity'),
'#required' => TRUE,
'#ajax' => [
'callback' => [
$this,
'cancelForm',
],
'wrapper' => '',
],
];
return $form;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
public | function | 2 | |
DependencySerializationTrait:: |
public | function | 2 | |
FormBase:: |
protected | property | The config factory. | 3 |
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. | 3 |
FormBase:: |
private | function | Returns the service container. | |
FormBase:: |
public static | function |
Instantiates a new instance of this class. Overrides ContainerInjectionInterface:: |
105 |
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. | |
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. | |
MaestroValidityCheck:: |
public | function |
Ajax callback for add-new-form button click. Overrides FormInterface:: |
|
MaestroValidityCheck:: |
public | function | ||
MaestroValidityCheck:: |
public | function |
Returns a unique string identifying the form. Overrides FormInterface:: |
|
MaestroValidityCheck:: |
public | function |
Form submission handler. Overrides FormInterface:: |
|
MaestroValidityCheck:: |
public | function |
Form validation handler. Overrides FormBase:: |
|
MessengerTrait:: |
protected | property | The messenger. | 27 |
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. |