namespace Drupal\image_widget_crop\Plugin\Field\FieldWidget;
+use Drupal\Core\Ajax\AjaxResponse;
+use Drupal\Core\Ajax\ReplaceCommand;
use Drupal\Core\Config\ConfigFactoryInterface;
use Drupal\Core\Config\Entity\ConfigEntityStorageInterface;
use Drupal\Core\Entity\EntityStorageInterface;
use Drupal\Core\Field\FieldDefinitionInterface;
use Drupal\Core\Field\FieldItemListInterface;
use Drupal\Core\Form\FormStateInterface;
+use Drupal\Core\Link;
use Drupal\Core\Render\ElementInfoManagerInterface;
use Drupal\image\Plugin\Field\FieldWidget\ImageWidget;
use Drupal\image_widget_crop\ImageWidgetCropInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Drupal\crop\Entity\CropType;
+use Drupal\Core\Render\Element\Select;
/**
* Plugin implementation of the 'image_widget_crop' widget.
/**
* {@inheritdoc}
- *
- * @return arraystringstring|null|bool
- * The array of settings.
*/
public static function defaultSettings() {
return [
'crop_preview_image_style' => 'crop_thumbnail',
- 'crop_list' => NULL,
+ 'crop_list' => [],
+ 'crop_types_required' => [],
'show_crop_area' => FALSE,
'show_default_crop' => TRUE,
'warn_multiple_usages' => TRUE,
'#show_default_crop' => $element['#show_default_crop'],
'#show_crop_area' => $element['#show_crop_area'],
'#warn_multiple_usages' => $element['#warn_multiple_usages'],
+ '#crop_types_required' => $element['#crop_types_required'],
];
}
}
* @param array $variables
* An array with all existent variables for render.
*
- * @return arraystringarray
+ * @return array[]
* The variables with width & height image informations.
*/
public static function getFileImageVariables(array $element, array &$variables) {
* {@inheritdoc}
*/
public function settingsForm(array $form, FormStateInterface $form_state) {
- $element = parent::settingsForm($form, $form_state);
+ if (!$crop_types_options = $this->imageWidgetCropManager->getAvailableCropType(CropType::getCropTypeNames())) {
+ $element['message'] = [
+ '#type' => 'container',
+ '#markup' => $this->t('No image style using the "manual crop" effect found. Please first go @link and attach the "manual crop" effect and then return to configure the field widget settings.', ['@link' => Link::createFromRoute('configure one here', 'entity.image_style.collection')->toString()]),
+ '#attributes' => [
+ 'class' => ['messages messages--error'],
+ ],
+ ];
+
+ // Stop process and display error message,
+ // if any available Image Style is set.
+ return $element;
+ }
+ $element = parent::settingsForm($form, $form_state);
$element['crop_preview_image_style'] = [
'#title' => $this->t('Crop preview image style'),
'#type' => 'select',
$element['crop_list'] = [
'#title' => $this->t('Crop Type'),
'#type' => 'select',
- '#options' => $this->imageWidgetCropManager->getAvailableCropType(CropType::getCropTypeNames()),
- '#empty_option' => $this->t('<@no-preview>', ['@no-preview' => $this->t('no preview')]),
+ '#options' => $crop_types_options,
'#default_value' => $this->getSetting('crop_list'),
'#multiple' => TRUE,
'#required' => TRUE,
'#description' => $this->t('The type of crop to apply to your image. If your Crop Type not appear here, set an image style use your Crop Type'),
'#weight' => 16,
+ '#ajax' => [
+ 'callback' => [static::class, 'updateCropTypeRequiredOptions'],
+ 'event' => 'change',
+ ],
+ ];
+
+ $element['crop_types_required'] = [
+ '#title' => $this->t('Required crop types'),
+ '#type' => 'select',
+ '#options' => $crop_types_options,
+ '#default_value' => $this->getSetting('crop_types_required'),
+ '#multiple' => TRUE,
+ '#description' => $this->t('Crop types that should be required.'),
+ '#weight' => 17,
];
$element['show_crop_area'] = [
'#default_value' => $this->getSetting('warn_multiple_usages'),
];
+ $element['crop_types_required']['#process'] = [
+ // We mandatory to re-attach 'processSelect'.
+ [Select::class, 'processSelect'],
+ [static::class, 'processCropTypesRequired'],
+ ];
+
+ return $element;
+ }
+
+ /**
+ * Render API callback: retrieve options for current form element.
+ *
+ * @param array $element
+ * An associative array containing the properties and children of the
+ * form actions container.
+ * @param \Drupal\Core\Form\FormStateInterface $form_state
+ * The current state of the form.
+ * @param array $complete_form
+ * The complete form structure.
+ *
+ * @return array
+ * The processed element.
+ */
+ public static function processCropTypesRequired(array &$element, FormStateInterface $form_state, array &$complete_form) {
+ if (!$form_state->getTriggeringElement()) {
+ return $element;
+ }
+
+ // Only display options chosen on 'crop_list',
+ // element in current form element.
+ $crop_list_form_element = self::getImageCropWidgetElement($form_state, 'crop_list');
+ if (empty($crop_list_form_element)) {
+ return $element;
+ }
+
+ $crop_list_options = $crop_list_form_element['#options'];
+ $crop_list_default_value = array_flip($crop_list_form_element['#default_value']);
+
+ // Populate element options with crop_list selected options.
+ $element['#options'] = array_intersect_key($crop_list_options, $crop_list_default_value);
+
return $element;
}
+ /**
+ * Ajax callback for 'crop_list' select element.
+ *
+ * This ajax callback takes care of the following things:
+ * - Fetching selected options on the 'crop_list' element.
+ *
+ * @param array $form
+ * An associative array containing the structure of the form.
+ * @param \Drupal\Core\Form\FormStateInterface $form_state
+ * The current state of the form.
+ *
+ * @return \Drupal\Core\Ajax\AjaxResponse
+ * The Ajax response.
+ */
+ public static function updateCropTypeRequiredOptions(array $form, FormStateInterface $form_state) {
+ $response = new AjaxResponse();
+ $triggering_element = $form_state->getTriggeringElement();
+ if (isset($triggering_element['#value'])) {
+ $crop_type_required_form = self::getImageCropWidgetElement($form_state, 'crop_types_required');
+ $crop_type_required_form['#options'] = array_intersect_key($triggering_element['#options'], $triggering_element['#value']);
+
+ /** @var \Drupal\Core\Render\RendererInterface $renderer */
+ $renderer = \Drupal::service('renderer');
+ $output = $renderer->renderRoot($crop_type_required_form);
+
+ // Transform field name onto field name class.
+ $field_name_class = str_replace('_', '-', $triggering_element['#parents'][1]);
+
+ // Re-construct triggered crop required form element class.
+ $element_fragments = [
+ 'form-item-',
+ 'fields-',
+ $field_name_class,
+ '-settings-edit-form-settings-',
+ 'crop-types-required',
+ ];
+
+ // Replace existing element with selected `crop_list` options.
+ $response->addCommand(new ReplaceCommand('.' . implode($element_fragments), $output));
+ }
+
+ return $response;
+ }
+
+ /**
+ * Return a specific of ImageCropWidget form element.
+ *
+ * @param \Drupal\Core\Form\FormStateInterface $form_state
+ * The current state of the form.
+ * @param string $key
+ * Name of element needed.
+ *
+ * @return array
+ * The form element needed by $key parameter.
+ */
+ public static function getImageCropWidgetElement(FormStateInterface $form_state, $key) {
+ $triggering_element = $form_state->getTriggeringElement();
+ $children = $triggering_element['#parents'][0];
+ $field_name = $triggering_element['#parents'][1];
+ $field_element_form = $form_state->getCompleteForm()[$children][$field_name];
+
+ return $field_element_form['plugin']['settings_edit_form']['settings'][$key] ?: [];
+ }
+
/**
* {@inheritdoc}
*
// Unset possible 'No defined styles' option.
unset($image_styles['']);
- // Styles could be lost because of enabled/disabled modules that defines
- // their styles in code.
+ $crop_list = $this->getSetting('crop_list');
+ if (empty($crop_list)) {
+ return [$this->t('No crop types selected.')];
+ }
+
$image_style_setting = $this->getSetting('preview_image_style');
$crop_preview = $image_styles[$this->getSetting('crop_preview_image_style')];
- $crop_list = $this->getSetting('crop_list');
$crop_show_button = $this->getSetting('show_crop_area');
$show_default_crop = $this->getSetting('show_default_crop');
$warn_multiple_usages = $this->getSetting('warn_multiple_usages');
+ $crop_required = $this->getSetting('crop_types_required');
$preview[] = $this->t('Always expand crop area: @bool', ['@bool' => ($crop_show_button) ? 'Yes' : 'No']);
$preview[] = $this->t('Show default crop area: @bool', ['@bool' => ($show_default_crop) ? 'Yes' : 'No']);
$preview[] = $this->t('Crop Type used: @list', ['@list' => implode(", ", $crop_list)]);
}
+ if (!empty($crop_required)) {
+ $preview[] = $this->t('Required crop types : @list', ['@list' => implode(", ", $crop_required)]);
+ }
+
return $preview;
}
/**
* {@inheritdoc}
*
- * @return arraystringarray
+ * @return array[]
* The form elements for a single widget for this field.
*/
public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
$element['#show_crop_area'] = $this->getSetting('show_crop_area');
$element['#show_default_crop'] = $this->getSetting('show_default_crop');
$element['#warn_multiple_usages'] = $this->getSetting('warn_multiple_usages');
+ $element['#crop_types_required'] = $this->getSetting('crop_types_required');
return parent::formElement($items, $delta, $element, $form, $form_state);
}
projects / yaffs-website / blobdiff