Code Coverage |
||||||||||
Classes and Traits |
Functions and Methods |
Lines |
||||||||
| Total | |
0.00% |
0 / 1 |
|
0.00% |
0 / 9 |
CRAP | |
0.00% |
0 / 187 |
| ImageWidget | |
0.00% |
0 / 1 |
|
0.00% |
0 / 9 |
1722 | |
0.00% |
0 / 187 |
| defaultSettings | |
0.00% |
0 / 1 |
2 | |
0.00% |
0 / 5 |
|||
| settingsForm | |
0.00% |
0 / 1 |
2 | |
0.00% |
0 / 12 |
|||
| settingsSummary | |
0.00% |
0 / 1 |
6 | |
0.00% |
0 / 13 |
|||
| formMultipleElements | |
0.00% |
0 / 1 |
12 | |
0.00% |
0 / 19 |
|||
| formElement | |
0.00% |
0 / 1 |
72 | |
0.00% |
0 / 24 |
|||
| process | |
0.00% |
0 / 1 |
210 | |
0.00% |
0 / 78 |
|||
| validateRequiredFields | |
0.00% |
0 / 1 |
12 | |
0.00% |
0 / 12 |
|||
| calculateDependencies | |
0.00% |
0 / 1 |
12 | |
0.00% |
0 / 7 |
|||
| onDependencyRemoval | |
0.00% |
0 / 1 |
42 | |
0.00% |
0 / 17 |
|||
| <?php | |
| /** | |
| * @file | |
| * Contains \Drupal\image\Plugin\Field\FieldWidget\ImageWidget. | |
| */ | |
| namespace Drupal\image\Plugin\Field\FieldWidget; | |
| use Drupal\Core\Field\FieldItemListInterface; | |
| use Drupal\Component\Utility\NestedArray; | |
| use Drupal\Core\Form\FormStateInterface; | |
| use Drupal\file\Entity\File; | |
| use Drupal\file\Plugin\Field\FieldWidget\FileWidget; | |
| use Drupal\image\Entity\ImageStyle; | |
| /** | |
| * Plugin implementation of the 'image_image' widget. | |
| * | |
| * @FieldWidget( | |
| * id = "image_image", | |
| * label = @Translation("Image"), | |
| * field_types = { | |
| * "image" | |
| * } | |
| * ) | |
| */ | |
| class ImageWidget extends FileWidget { | |
| /** | |
| * {@inheritdoc} | |
| */ | |
| public static function defaultSettings() { | |
| return array( | |
| 'progress_indicator' => 'throbber', | |
| 'preview_image_style' => 'thumbnail', | |
| ) + parent::defaultSettings(); | |
| } | |
| /** | |
| * {@inheritdoc} | |
| */ | |
| public function settingsForm(array $form, FormStateInterface $form_state) { | |
| $element = parent::settingsForm($form, $form_state); | |
| $element['preview_image_style'] = array( | |
| '#title' => t('Preview image style'), | |
| '#type' => 'select', | |
| '#options' => image_style_options(FALSE), | |
| '#empty_option' => '<' . t('no preview') . '>', | |
| '#default_value' => $this->getSetting('preview_image_style'), | |
| '#description' => t('The preview image will be shown while editing the content.'), | |
| '#weight' => 15, | |
| ); | |
| return $element; | |
| } | |
| /** | |
| * {@inheritdoc} | |
| */ | |
| public function settingsSummary() { | |
| $summary = parent::settingsSummary(); | |
| $image_styles = image_style_options(FALSE); | |
| // Unset possible 'No defined styles' option. | |
| unset($image_styles['']); | |
| // Styles could be lost because of enabled/disabled modules that defines | |
| // their styles in code. | |
| $image_style_setting = $this->getSetting('preview_image_style'); | |
| if (isset($image_styles[$image_style_setting])) { | |
| $preview_image_style = t('Preview image style: @style', array('@style' => $image_styles[$image_style_setting])); | |
| } | |
| else { | |
| $preview_image_style = t('No preview'); | |
| } | |
| array_unshift($summary, $preview_image_style); | |
| return $summary; | |
| } | |
| /** | |
| * Overrides \Drupal\file\Plugin\Field\FieldWidget\FileWidget::formMultipleElements(). | |
| * | |
| * Special handling for draggable multiple widgets and 'add more' button. | |
| */ | |
| protected function formMultipleElements(FieldItemListInterface $items, array &$form, FormStateInterface $form_state) { | |
| $elements = parent::formMultipleElements($items, $form, $form_state); | |
| $cardinality = $this->fieldDefinition->getFieldStorageDefinition()->getCardinality(); | |
| $file_upload_help = array( | |
| '#theme' => 'file_upload_help', | |
| '#description' => '', | |
| '#upload_validators' => $elements[0]['#upload_validators'], | |
| '#cardinality' => $cardinality, | |
| ); | |
| if ($cardinality == 1) { | |
| // If there's only one field, return it as delta 0. | |
| if (empty($elements[0]['#default_value']['fids'])) { | |
| $file_upload_help['#description'] = $this->fieldDefinition->getDescription(); | |
| $elements[0]['#description'] = \Drupal::service('renderer')->renderPlain($file_upload_help); | |
| } | |
| } | |
| else { | |
| $elements['#file_upload_description'] = $file_upload_help; | |
| } | |
| return $elements; | |
| } | |
| /** | |
| * {@inheritdoc} | |
| */ | |
| public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) { | |
| $element = parent::formElement($items, $delta, $element, $form, $form_state); | |
| $field_settings = $this->getFieldSettings(); | |
| // Add upload resolution validation. | |
| if ($field_settings['max_resolution'] || $field_settings['min_resolution']) { | |
| $element['#upload_validators']['file_validate_image_resolution'] = array($field_settings['max_resolution'], $field_settings['min_resolution']); | |
| } | |
| // If not using custom extension validation, ensure this is an image. | |
| $supported_extensions = array('png', 'gif', 'jpg', 'jpeg'); | |
| $extensions = isset($element['#upload_validators']['file_validate_extensions'][0]) ? $element['#upload_validators']['file_validate_extensions'][0] : implode(' ', $supported_extensions); | |
| $extensions = array_intersect(explode(' ', $extensions), $supported_extensions); | |
| $element['#upload_validators']['file_validate_extensions'][0] = implode(' ', $extensions); | |
| // Add properties needed by process() method. | |
| $element['#preview_image_style'] = $this->getSetting('preview_image_style'); | |
| $element['#title_field'] = $field_settings['title_field']; | |
| $element['#title_field_required'] = $field_settings['title_field_required']; | |
| $element['#alt_field'] = $field_settings['alt_field']; | |
| $element['#alt_field_required'] = $field_settings['alt_field_required']; | |
| // Default image. | |
| $default_image = $field_settings['default_image']; | |
| if (empty($default_image['uuid'])) { | |
| $default_image = $this->fieldDefinition->getFieldStorageDefinition()->getSetting('default_image'); | |
| } | |
| // Convert the stored UUID into a file ID. | |
| if (!empty($default_image['uuid']) && $entity = \Drupal::entityManager()->loadEntityByUuid('file', $default_image['uuid'])) { | |
| $default_image['fid'] = $entity->id(); | |
| } | |
| $element['#default_image'] = !empty($default_image['fid']) ? $default_image : array(); | |
| return $element; | |
| } | |
| /** | |
| * Form API callback: Processes a image_image field element. | |
| * | |
| * Expands the image_image type to include the alt and title fields. | |
| * | |
| * This method is assigned as a #process callback in formElement() method. | |
| */ | |
| public static function process($element, FormStateInterface $form_state, $form) { | |
| $item = $element['#value']; | |
| $item['fids'] = $element['fids']['#value']; | |
| $element['#theme'] = 'image_widget'; | |
| // Add the image preview. | |
| if (!empty($element['#files']) && $element['#preview_image_style']) { | |
| $file = reset($element['#files']); | |
| $variables = array( | |
| 'style_name' => $element['#preview_image_style'], | |
| 'uri' => $file->getFileUri(), | |
| ); | |
| // Determine image dimensions. | |
| if (isset($element['#value']['width']) && isset($element['#value']['height'])) { | |
| $variables['width'] = $element['#value']['width']; | |
| $variables['height'] = $element['#value']['height']; | |
| } | |
| else { | |
| $image = \Drupal::service('image.factory')->get($file->getFileUri()); | |
| if ($image->isValid()) { | |
| $variables['width'] = $image->getWidth(); | |
| $variables['height'] = $image->getHeight(); | |
| } | |
| else { | |
| $variables['width'] = $variables['height'] = NULL; | |
| } | |
| } | |
| $element['preview'] = array( | |
| '#weight' => -10, | |
| '#theme' => 'image_style', | |
| '#width' => $variables['width'], | |
| '#height' => $variables['height'], | |
| '#style_name' => $variables['style_name'], | |
| '#uri' => $variables['uri'], | |
| ); | |
| // Store the dimensions in the form so the file doesn't have to be | |
| // accessed again. This is important for remote files. | |
| $element['width'] = array( | |
| '#type' => 'hidden', | |
| '#value' => $variables['width'], | |
| ); | |
| $element['height'] = array( | |
| '#type' => 'hidden', | |
| '#value' => $variables['height'], | |
| ); | |
| } | |
| elseif (!empty($element['#default_image'])) { | |
| $default_image = $element['#default_image']; | |
| $file = File::load($default_image['fid']); | |
| if (!empty($file)) { | |
| $element['preview'] = array( | |
| '#weight' => -10, | |
| '#theme' => 'image_style', | |
| '#width' => $default_image['width'], | |
| '#height' => $default_image['height'], | |
| '#style_name' => $element['#preview_image_style'], | |
| '#uri' => $file->getFileUri(), | |
| ); | |
| } | |
| } | |
| // Add the additional alt and title fields. | |
| $element['alt'] = array( | |
| '#title' => t('Alternative text'), | |
| '#type' => 'textfield', | |
| '#default_value' => isset($item['alt']) ? $item['alt'] : '', | |
| '#description' => t('This text will be used by screen readers, search engines, or when the image cannot be loaded.'), | |
| // @see https://www.drupal.org/node/465106#alt-text | |
| '#maxlength' => 512, | |
| '#weight' => -12, | |
| '#access' => (bool) $item['fids'] && $element['#alt_field'], | |
| '#required' => $element['#alt_field_required'], | |
| '#element_validate' => $element['#alt_field_required'] == 1 ? array(array(get_called_class(), 'validateRequiredFields')) : array(), | |
| ); | |
| $element['title'] = array( | |
| '#type' => 'textfield', | |
| '#title' => t('Title'), | |
| '#default_value' => isset($item['title']) ? $item['title'] : '', | |
| '#description' => t('The title is used as a tool tip when the user hovers the mouse over the image.'), | |
| '#maxlength' => 1024, | |
| '#weight' => -11, | |
| '#access' => (bool) $item['fids'] && $element['#title_field'], | |
| '#required' => $element['#title_field_required'], | |
| '#element_validate' => $element['#title_field_required'] == 1 ? array(array(get_called_class(), 'validateRequiredFields')) : array(), | |
| ); | |
| return parent::process($element, $form_state, $form); | |
| } | |
| /** | |
| * Validate callback for alt and title field, if the user wants them required. | |
| * | |
| * This is separated in a validate function instead of a #required flag to | |
| * avoid being validated on the process callback. | |
| */ | |
| public static function validateRequiredFields($element, FormStateInterface $form_state) { | |
| // Only do validation if the function is triggered from other places than | |
| // the image process form. | |
| if (!in_array('file_managed_file_submit', $form_state->getTriggeringElement()['#submit'])) { | |
| // If the image is not there, we do not check for empty values. | |
| $parents = $element['#parents']; | |
| $field = array_pop($parents); | |
| $image_field = NestedArray::getValue($form_state->getUserInput(), $parents); | |
| // We check for the array key, so that it can be NULL (like if the user | |
| // submits the form without using the "upload" button). | |
| if (!array_key_exists($field, $image_field)) { | |
| return; | |
| } | |
| } | |
| else { | |
| $form_state->setLimitValidationErrors([]); | |
| } | |
| } | |
| /** | |
| * {@inheritdoc} | |
| */ | |
| public function calculateDependencies() { | |
| $dependencies = parent::calculateDependencies(); | |
| $style_id = $this->getSetting('preview_image_style'); | |
| /** @var \Drupal\image\ImageStyleInterface $style */ | |
| if ($style_id && $style = ImageStyle::load($style_id)) { | |
| // If this widget uses a valid image style to display the preview of the | |
| // uploaded image, add that image style configuration entity as dependency | |
| // of this widget. | |
| $dependencies[$style->getConfigDependencyKey()][] = $style->getConfigDependencyName(); | |
| } | |
| return $dependencies; | |
| } | |
| /** | |
| * {@inheritdoc} | |
| */ | |
| public function onDependencyRemoval(array $dependencies) { | |
| $changed = parent::onDependencyRemoval($dependencies); | |
| $style_id = $this->getSetting('preview_image_style'); | |
| /** @var \Drupal\image\ImageStyleInterface $style */ | |
| if ($style_id && $style = ImageStyle::load($style_id)) { | |
| if (!empty($dependencies[$style->getConfigDependencyKey()][$style->getConfigDependencyName()])) { | |
| /** @var \Drupal\image\ImageStyleStorageInterface $storage */ | |
| $storage = \Drupal::entityManager()->getStorage($style->getEntityTypeId()); | |
| $replacement_id = $storage->getReplacementId($style_id); | |
| // If a valid replacement has been provided in the storage, replace the | |
| // preview image style with the replacement. | |
| if ($replacement_id && ImageStyle::load($replacement_id)) { | |
| $this->setSetting('preview_image_style', $replacement_id); | |
| } | |
| // If there's no replacement or the replacement is invalid, disable the | |
| // image preview. | |
| else { | |
| $this->setSetting('preview_image_style', ''); | |
| } | |
| // Signal that the formatter plugin settings were updated. | |
| $changed = TRUE; | |
| } | |
| } | |
| return $changed; | |
| } | |
| } |