You are here

Home » API reference » Image Widget Crop 8 » ImageCropWidget.php

class ImageCropWidget in Image Widget Crop 8

Same name and namespace in other branches
  1. 8.2 src/Plugin/Field/FieldWidget/ImageCropWidget.php \Drupal\image_widget_crop\Plugin\Field\FieldWidget\ImageCropWidget

Plugin implementation of the 'image_widget_crop' widget.

Plugin annotation


@FieldWidget(
  id = "image_widget_crop",
  label = @Translation("ImageWidget crop"),
  field_types = {
    "image"
  }
)

Hierarchy

Expanded class hierarchy of ImageCropWidget

File

src/Plugin/Field/FieldWidget/ImageCropWidget.php, line 28

Namespace

Drupal\image_widget_crop\Plugin\Field\FieldWidget
View source 
class ImageCropWidget extends ImageWidget {

  /**
   * Instance of API ImageWidgetCropManager.
   *
   * @var \Drupal\image_widget_crop\ImageWidgetCropManager
   */
  protected $imageWidgetCropManager;

  /**
   * The image style storage.
   *
   * @var \Drupal\image\ImageStyleStorageInterface
   */
  protected $imageStyleStorage;

  /**
   * The crop type storage.
   *
   * @var \Drupal\Core\Config\Entity\ConfigEntityStorage
   */
  protected $cropTypeStorage;

  /**
   * The config factory.
   *
   * Subclasses should use the self::config() method, which may be overridden to
   * address specific needs when loading config, rather than this property
   * directly. See \Drupal\Core\Form\ConfigFormBase::config() for an example of
   * this.
   *
   * @var \Drupal\Core\Config\ConfigFactoryInterface
   */
  protected $configFactory;

  /**
   * {@inheritdoc}
   */
  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, array $third_party_settings, ElementInfoManagerInterface $element_info, ImageWidgetCropManager $image_widget_crop_manager, EntityStorageInterface $image_style_storage, ConfigEntityStorageInterface $crop_type_storage, ConfigFactoryInterface $config_factory) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $third_party_settings, $element_info);
    $this->imageWidgetCropManager = $image_widget_crop_manager;
    $this->imageStyleStorage = $image_style_storage;
    $this->cropTypeStorage = $crop_type_storage;
    $this->configFactory = $config_factory;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($plugin_id, $plugin_definition, $configuration['field_definition'], $configuration['settings'], $configuration['third_party_settings'], $container
      ->get('element_info'), $container
      ->get('image_widget_crop.manager'), $container
      ->get('entity_type.manager')
      ->getStorage('image_style'), $container
      ->get('entity_type.manager')
      ->getStorage('crop_type'), $container
      ->get('config.factory'));
  }

  /**
   * {@inheritdoc}
   *
   * @return array<string,string|null|false>
   *   The array of settings.
   */
  public static function defaultSettings() {
    return [
      'crop_preview_image_style' => 'crop_thumbnail',
      'crop_list' => NULL,
      'show_crop_area' => FALSE,
      'show_default_crop' => TRUE,
      'warn_multiple_usages' => TRUE,
    ] + parent::defaultSettings();
  }

  /**
   * Form API callback: Processes a crop_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.
   *
   * @return array
   *   The elements with parents fields.
   */
  public static function process($element, FormStateInterface $form_state, $form) {
    if ($element['#files']) {
      foreach ($element['#files'] as $file) {
        $element['image_crop'] = [
          '#type' => 'image_crop',
          '#file' => $file,
          '#crop_type_list' => $element['#crop_list'],
          '#crop_preview_image_style' => $element['#crop_preview_image_style'],
          '#show_default_crop' => $element['#show_default_crop'],
          '#show_crop_area' => $element['#show_crop_area'],
          '#warn_multiple_usages' => $element['#warn_multiple_usages'],
        ];
      }
    }
    return parent::process($element, $form_state, $form);
  }

  /**
   * Verify if the element have an image file.
   *
   * @param array $element
   *   A form element array containing basic properties for the widget.
   * @param array $variables
   *   An array with all existent variables for render.
   *
   * @return array<string,array>
   *   The variables with width & height image informations.
   */
  public static function getFileImageVariables(array $element, array &$variables) {

    // Determine image dimensions.
    if (isset($element['#value']['width']) && isset($element['#value']['height'])) {
      $variables['width'] = $element['#value']['width'];
      $variables['height'] = $element['#value']['height'];
    }
    else {

      /** @var \Drupal\Core\Image\Image $image */
      $image = \Drupal::service('image.factory')
        ->get($variables['uri']);
      if ($image
        ->isValid()) {
        $variables['width'] = $image
          ->getWidth();
        $variables['height'] = $image
          ->getHeight();
      }
      else {
        $variables['width'] = $variables['height'] = NULL;
      }
    }
    return $variables;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $element = parent::settingsForm($form, $form_state);
    $element['crop_preview_image_style'] = [
      '#title' => $this
        ->t('Crop preview image style'),
      '#type' => 'select',
      '#options' => $this->imageWidgetCropManager
        ->getAvailableCropImageStyle(image_style_options(FALSE)),
      '#default_value' => $this
        ->getSetting('crop_preview_image_style'),
      '#description' => $this
        ->t('The preview image will be shown while editing the content.'),
      '#weight' => 15,
    ];
    $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'),
      ]),
      '#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,
    ];
    $element['show_crop_area'] = [
      '#title' => $this
        ->t('Always expand crop area'),
      '#type' => 'checkbox',
      '#default_value' => $this
        ->getSetting('show_crop_area'),
    ];
    $element['show_default_crop'] = [
      '#title' => $this
        ->t('Show default crop area'),
      '#type' => 'checkbox',
      '#default_value' => $this
        ->getSetting('show_default_crop'),
    ];
    $element['warn_multiple_usages'] = [
      '#title' => $this
        ->t('Warn the user if the crop is used more than once.'),
      '#type' => 'checkbox',
      '#default_value' => $this
        ->getSetting('warn_multiple_usages'),
    ];
    return $element;
  }

  /**
   * {@inheritdoc}
   *
   * @return array<array>
   *   A short summary of the widget settings.
   */
  public function settingsSummary() {
    $preview = [];
    $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');
    $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');
    $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('Warn the user if the crop is used more than once: @bool', [
      '@bool' => $warn_multiple_usages ? 'Yes' : 'No',
    ]);
    if (isset($image_styles[$image_style_setting])) {
      $preview[] = $this
        ->t('Preview image style: @style', [
        '@style' => $image_style_setting,
      ]);
    }
    else {
      $preview[] = $this
        ->t('No preview image style');
    }
    if (isset($crop_preview)) {
      $preview[] = $this
        ->t('Preview crop zone image style: @style', [
        '@style' => $crop_preview,
      ]);
    }
    if (!empty($crop_list)) {
      $preview[] = $this
        ->t('Crop Type used: @list', [
        '@list' => implode(", ", $crop_list),
      ]);
    }
    return $preview;
  }

  /**
   * {@inheritdoc}
   *
   * @return array<string,array>
   *   The form elements for a single widget for this field.
   */
  public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {

    // Add properties needed by process() method.
    $element['#crop_list'] = $this
      ->getSetting('crop_list');
    $element['#crop_preview_image_style'] = $this
      ->getSetting('crop_preview_image_style');
    $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');
    return parent::formElement($items, $delta, $element, $form, $form_state);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AllowedTagsXssTrait::allowedTags public function Returns a list of tags allowed by AllowedTagsXssTrait::fieldFilterXss().
AllowedTagsXssTrait::displayAllowedTags public function Returns a human-readable list of allowed tags for display in help texts.
AllowedTagsXssTrait::fieldFilterXss public function Filters an HTML string to prevent XSS vulnerabilities.
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
FileWidget::extractFormValues public function Extracts field values from submitted form values. Overrides WidgetBase::extractFormValues
FileWidget::flagErrors public function Reports field-level validation errors against actual form elements. Overrides WidgetBase::flagErrors
FileWidget::getDescriptionFromElement protected static function Retrieves the file description from a field field element.
FileWidget::massageFormValues public function Massages the form values into the format expected for field values. Overrides WidgetBase::massageFormValues
FileWidget::processMultiple public static function Form API callback: Processes a group of file_generic field elements.
FileWidget::submit public static function Form submission handler for upload/remove button of formElement().
FileWidget::validateMultipleCount public static function Form element validation callback for upload element on file widget. Checks if user has uploaded more files than allowed.
FileWidget::value public static function Form API callback. Retrieves the value for the file_generic field element.
ImageCropWidget::$configFactory protected property The config factory.
ImageCropWidget::$cropTypeStorage protected property The crop type storage.
ImageCropWidget::$imageStyleStorage protected property The image style storage.
ImageCropWidget::$imageWidgetCropManager protected property Instance of API ImageWidgetCropManager.
ImageCropWidget::create public static function Creates an instance of the plugin. Overrides FileWidget::create
ImageCropWidget::defaultSettings public static function Overrides ImageWidget::defaultSettings
ImageCropWidget::formElement public function Overrides ImageWidget::formElement
ImageCropWidget::getFileImageVariables public static function Verify if the element have an image file.
ImageCropWidget::process public static function Form API callback: Processes a crop_image field element. Overrides ImageWidget::process
ImageCropWidget::settingsForm public function Returns a form to configure settings for the widget. Overrides ImageWidget::settingsForm
ImageCropWidget::settingsSummary public function Overrides ImageWidget::settingsSummary
ImageCropWidget::__construct public function Constructs an ImageWidget object. Overrides ImageWidget::__construct
ImageWidget::$imageFactory protected property The image factory service.
ImageWidget::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides PluginSettingsBase::calculateDependencies
ImageWidget::formMultipleElements protected function Overrides \Drupal\file\Plugin\Field\FieldWidget\FileWidget::formMultipleElements(). Overrides FileWidget::formMultipleElements
ImageWidget::onDependencyRemoval public function Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsBase::onDependencyRemoval
ImageWidget::validateRequiredFields public static function Validate callback for alt and title field, if the user wants them required.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginSettingsBase::$defaultSettingsMerged protected property Whether default settings have been merged into the current $settings.
PluginSettingsBase::$thirdPartySettings protected property The plugin settings injected by third party modules.
PluginSettingsBase::getSetting public function Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface::getSetting
PluginSettingsBase::getSettings public function Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface::getSettings
PluginSettingsBase::getThirdPartyProviders public function Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
PluginSettingsBase::getThirdPartySetting public function Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
PluginSettingsBase::getThirdPartySettings public function Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
PluginSettingsBase::mergeDefaults protected function Merges default settings values into $settings.
PluginSettingsBase::setSetting public function Sets the value of a setting for the plugin. Overrides PluginSettingsInterface::setSetting
PluginSettingsBase::setSettings public function Sets the settings for the plugin. Overrides PluginSettingsInterface::setSettings
PluginSettingsBase::setThirdPartySetting public function Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
PluginSettingsBase::unsetThirdPartySetting public function Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
WidgetBase::$fieldDefinition protected property The field definition.
WidgetBase::$settings protected property The widget settings. Overrides PluginSettingsBase::$settings
WidgetBase::addMoreAjax public static function Ajax callback for the "Add another item" button.
WidgetBase::addMoreSubmit public static function Submission handler for the "Add another item" button.
WidgetBase::afterBuild public static function After-build handler for field elements in a form.
WidgetBase::errorElement public function Assigns a field-level validation error to the right widget sub-element. Overrides WidgetInterface::errorElement 8
WidgetBase::form public function Creates a form element for a field. Overrides WidgetBaseInterface::form 3
WidgetBase::formSingleElement protected function Generates the form element for a single copy of the widget.
WidgetBase::getFieldSetting protected function Returns the value of a field setting.
WidgetBase::getFieldSettings protected function Returns the array of field settings.
WidgetBase::getFilteredDescription protected function Returns the filtered field description.
WidgetBase::getWidgetState public static function Retrieves processing information about the widget from $form_state. Overrides WidgetBaseInterface::getWidgetState
WidgetBase::getWidgetStateParents protected static function Returns the location of processing information within $form_state.
WidgetBase::handlesMultipleValues protected function Returns whether the widget handles multiple values.
WidgetBase::isApplicable public static function Returns if the widget can be used for the provided field. Overrides WidgetInterface::isApplicable 4
WidgetBase::isDefaultValueWidget protected function Returns whether the widget used for default value form.
WidgetBase::setWidgetState public static function Stores processing information about the widget in $form_state. Overrides WidgetBaseInterface::setWidgetState