abstract class ImageAPIOptimizeProcessorFormBase in Image Optimize (or ImageAPI Optimize) 4.x
Same name and namespace in other branches
- 8.3 src/Form/ImageAPIOptimizeProcessorFormBase.php \Drupal\imageapi_optimize\Form\ImageAPIOptimizeProcessorFormBase
- 8.2 src/Form/ImageAPIOptimizeProcessorFormBase.php \Drupal\imageapi_optimize\Form\ImageAPIOptimizeProcessorFormBase
Provides a base form for image optimize processors.
Hierarchy
- class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
- class \Drupal\imageapi_optimize\Form\ImageAPIOptimizeProcessorFormBase
Expanded class hierarchy of ImageAPIOptimizeProcessorFormBase
File
- src/
Form/ ImageAPIOptimizeProcessorFormBase.php, line 16
Namespace
Drupal\imageapi_optimize\FormView source
abstract class ImageAPIOptimizeProcessorFormBase extends FormBase {
/**
* The image optimize pipeline.
*
* @var \Drupal\imageapi_optimize\ImageAPIOptimizePipelineInterface
*/
protected $imageAPIOptimizePipeline;
/**
* The image optimize processor.
*
* @var \Drupal\imageapi_optimize\ImageAPIOptimizeProcessorInterface|\Drupal\imageapi_optimize\ConfigurableImageAPIOptimizeProcessorInterface
*/
protected $imageAPIOptimizeProcessor;
/**
* {@inheritdoc}
*/
public function getFormId() {
return 'imageapi_optimize_processor_form';
}
/**
* {@inheritdoc}
*
* @param \Drupal\imageapi_optimize\ImageAPIOptimizePipelineInterface $imageapi_optimize_pipeline
* The image optimize pipeline.
* @param string $imageapi_optimize_processor
* The image optimize processor ID.
*
* @return array
* The form structure.
*
* @throws \Symfony\Component\HttpKernel\Exception\NotFoundHttpException
*/
public function buildForm(array $form, FormStateInterface $form_state, ImageAPIOptimizePipelineInterface $imageapi_optimize_pipeline = NULL, $imageapi_optimize_processor = NULL) {
$this->imageAPIOptimizePipeline = $imageapi_optimize_pipeline;
try {
$this->imageAPIOptimizeProcessor = $this
->prepareImageAPIOptimizeProcessor($imageapi_optimize_processor);
} catch (PluginNotFoundException $e) {
throw new NotFoundHttpException("Invalid processor id: '{$imageapi_optimize_processor}'.");
}
$request = $this
->getRequest();
if (!$this->imageAPIOptimizeProcessor instanceof ConfigurableImageAPIOptimizeProcessorInterface) {
throw new NotFoundHttpException();
}
$form['#attached']['library'][] = 'imageapi_optimize/admin';
$form['uuid'] = [
'#type' => 'value',
'#value' => $this->imageAPIOptimizeProcessor
->getUuid(),
];
$form['id'] = [
'#type' => 'value',
'#value' => $this->imageAPIOptimizeProcessor
->getPluginId(),
];
$form['data'] = [];
$subform_state = SubformState::createForSubform($form['data'], $form, $form_state);
$form['data'] = $this->imageAPIOptimizeProcessor
->buildConfigurationForm($form['data'], $subform_state);
$form['data']['#tree'] = TRUE;
// Check the URL for a weight, then the image optimize processor, otherwise use default.
$form['weight'] = [
'#type' => 'hidden',
'#value' => $request->query
->has('weight') ? (int) $request->query
->get('weight') : $this->imageAPIOptimizeProcessor
->getWeight(),
];
$form['actions'] = [
'#type' => 'actions',
];
$form['actions']['submit'] = [
'#type' => 'submit',
'#button_type' => 'primary',
];
$form['actions']['cancel'] = [
'#type' => 'link',
'#title' => $this
->t('Cancel'),
'#url' => $this->imageAPIOptimizePipeline
->toUrl('edit-form'),
'#attributes' => [
'class' => [
'button',
],
],
];
return $form;
}
/**
* {@inheritdoc}
*/
public function validateForm(array &$form, FormStateInterface $form_state) {
// The image optimize processor configuration is stored in the 'data' key in the form,
// pass that through for validation.
$this->imageAPIOptimizeProcessor
->validateConfigurationForm($form['data'], SubformState::createForSubform($form['data'], $form, $form_state));
}
/**
* {@inheritdoc}
*/
public function submitForm(array &$form, FormStateInterface $form_state) {
$form_state
->cleanValues();
// The image optimize processor configuration is stored in the 'data' key in the form,
// pass that through for submission.
$this->imageAPIOptimizeProcessor
->submitConfigurationForm($form['data'], SubformState::createForSubform($form['data'], $form, $form_state));
$this->imageAPIOptimizeProcessor
->setWeight($form_state
->getValue('weight'));
if (!$this->imageAPIOptimizeProcessor
->getUuid()) {
$this->imageAPIOptimizePipeline
->addProcessor($this->imageAPIOptimizeProcessor
->getConfiguration());
}
$this->imageAPIOptimizePipeline
->save();
$this
->messenger()
->addMessage($this
->t('The Image Optimize processor was successfully applied.'));
$form_state
->setRedirectUrl($this->imageAPIOptimizePipeline
->toUrl('edit-form'));
}
/**
* Converts an image optimize processor ID into an object.
*
* @param string $imageapi_optimize_processor
* The image optimize processor ID.
*
* @return \Drupal\imageapi_optimize\ImageAPIOptimizeProcessorInterface
* The image optimize processor object.
*/
protected abstract function prepareImageAPIOptimizeProcessor($imageapi_optimize_processor);
}
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. | |
ImageAPIOptimizeProcessorFormBase:: |
protected | property | The image optimize pipeline. | |
ImageAPIOptimizeProcessorFormBase:: |
protected | property | The image optimize processor. | |
ImageAPIOptimizeProcessorFormBase:: |
public | function |
Overrides FormInterface:: |
2 |
ImageAPIOptimizeProcessorFormBase:: |
public | function |
Returns a unique string identifying the form. Overrides FormInterface:: |
|
ImageAPIOptimizeProcessorFormBase:: |
abstract protected | function | Converts an image optimize processor ID into an object. | 2 |
ImageAPIOptimizeProcessorFormBase:: |
public | function |
Form submission handler. Overrides FormInterface:: |
|
ImageAPIOptimizeProcessorFormBase:: |
public | function |
Form validation handler. Overrides FormBase:: |
|
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. | 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. |