abstract class ImageEffectFormBase in Zircon Profile 8
Same name and namespace in other branches
- 8.0 core/modules/image/src/Form/ImageEffectFormBase.php \Drupal\image\Form\ImageEffectFormBase
Provides a base form for image effects.
Hierarchy
- class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\image\Form\ImageEffectFormBase
Expanded class hierarchy of ImageEffectFormBase
File
- core/
modules/ image/ src/ Form/ ImageEffectFormBase.php, line 21 - Contains \Drupal\image\Form\ImageEffectFormBase.
Namespace
Drupal\image\FormView source
abstract class ImageEffectFormBase extends FormBase {
/**
* The image style.
*
* @var \Drupal\image\ImageStyleInterface
*/
protected $imageStyle;
/**
* The image effect.
*
* @var \Drupal\image\ImageEffectInterface
*/
protected $imageEffect;
/**
* {@inheritdoc}
*/
public function getFormId() {
return 'image_effect_form';
}
/**
* {@inheritdoc}
*
* @param \Drupal\image\ImageStyleInterface $image_style
* The image style.
* @param string $image_effect
* The image effect ID.
*
* @return array
* The form structure.
*
* @throws \Symfony\Component\HttpKernel\Exception\NotFoundHttpException
*/
public function buildForm(array $form, FormStateInterface $form_state, ImageStyleInterface $image_style = NULL, $image_effect = NULL) {
$this->imageStyle = $image_style;
try {
$this->imageEffect = $this
->prepareImageEffect($image_effect);
} catch (PluginNotFoundException $e) {
throw new NotFoundHttpException("Invalid effect id: '{$image_effect}'.");
}
$request = $this
->getRequest();
if (!$this->imageEffect instanceof ConfigurableImageEffectInterface) {
throw new NotFoundHttpException();
}
$form['#attached']['library'][] = 'image/admin';
$form['uuid'] = array(
'#type' => 'value',
'#value' => $this->imageEffect
->getUuid(),
);
$form['id'] = array(
'#type' => 'value',
'#value' => $this->imageEffect
->getPluginId(),
);
$form['data'] = $this->imageEffect
->buildConfigurationForm(array(), $form_state);
$form['data']['#tree'] = TRUE;
// Check the URL for a weight, then the image effect, otherwise use default.
$form['weight'] = array(
'#type' => 'hidden',
'#value' => $request->query
->has('weight') ? (int) $request->query
->get('weight') : $this->imageEffect
->getWeight(),
);
$form['actions'] = array(
'#type' => 'actions',
);
$form['actions']['submit'] = array(
'#type' => 'submit',
'#button_type' => 'primary',
);
$form['actions']['cancel'] = array(
'#type' => 'link',
'#title' => $this
->t('Cancel'),
'#url' => $this->imageStyle
->urlInfo('edit-form'),
'#attributes' => [
'class' => [
'button',
],
],
);
return $form;
}
/**
* {@inheritdoc}
*/
public function validateForm(array &$form, FormStateInterface $form_state) {
// The image effect configuration is stored in the 'data' key in the form,
// pass that through for validation.
$effect_data = (new FormState())
->setValues($form_state
->getValue('data'));
$this->imageEffect
->validateConfigurationForm($form, $effect_data);
// Update the original form values.
$form_state
->setValue('data', $effect_data
->getValues());
}
/**
* {@inheritdoc}
*/
public function submitForm(array &$form, FormStateInterface $form_state) {
$form_state
->cleanValues();
// The image effect configuration is stored in the 'data' key in the form,
// pass that through for submission.
$effect_data = (new FormState())
->setValues($form_state
->getValue('data'));
$this->imageEffect
->submitConfigurationForm($form, $effect_data);
// Update the original form values.
$form_state
->setValue('data', $effect_data
->getValues());
$this->imageEffect
->setWeight($form_state
->getValue('weight'));
if (!$this->imageEffect
->getUuid()) {
$this->imageStyle
->addImageEffect($this->imageEffect
->getConfiguration());
}
$this->imageStyle
->save();
drupal_set_message($this
->t('The image effect was successfully applied.'));
$form_state
->setRedirectUrl($this->imageStyle
->urlInfo('edit-form'));
}
/**
* Converts an image effect ID into an object.
*
* @param string $image_effect
* The image effect ID.
*
* @return \Drupal\image\ImageEffectInterface
* The image effect object.
*/
protected abstract function prepareImageEffect($image_effect);
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
FormBase:: |
protected | property | The config factory. | 3 |
FormBase:: |
protected | property | The logger factory. | |
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:: |
84 |
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:: |
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. | |
ImageEffectFormBase:: |
protected | property | The image effect. | |
ImageEffectFormBase:: |
protected | property | The image style. | |
ImageEffectFormBase:: |
public | function |
Overrides FormInterface:: |
2 |
ImageEffectFormBase:: |
public | function |
Returns a unique string identifying the form. Overrides FormInterface:: |
|
ImageEffectFormBase:: |
abstract protected | function | Converts an image effect ID into an object. | 2 |
ImageEffectFormBase:: |
public | function |
Form submission handler. Overrides FormInterface:: |
|
ImageEffectFormBase:: |
public | function |
Form validation handler. Overrides FormBase:: |
|
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. | |
RedirectDestinationTrait:: |
protected | property | The redirect destination service. | |
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. | |
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:: |
protected | function | Returns a redirect response object for the specified route. | |
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. |