You are here

Home » API reference » Link Image Field 8 » LinkImageFieldWidget.php

class LinkImageFieldWidget in Link Image Field 8

Plugin implementation of the 'linkimagefield' widget.

Plugin annotation


@FieldWidget(
  id = "linkimagefield_widget",
  label = @Translation("Link Image"),
  field_types = {
    "linkimagefield"
  }
)

Hierarchy

Expanded class hierarchy of LinkImageFieldWidget

File

lib/Drupal/linkimagefield/Plugin/Field/FieldWidget/LinkImageFieldWidget.php, line 19

Namespace

Drupal\linkimagefield\Plugin\Field\FieldWidget
View source 
class LinkImageFieldWidget extends ImageWidget {

  /**
   * {@inheritdoc}
   */
  public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, array &$form_state) {
    $element = parent::formElement($items, $delta, $element, $form, $form_state);
    $element['#process'][] = array(
      get_class($this),
      'process',
    );

    // Allow to use settings in process function.
    $settings = $this
      ->getFieldSettings();
    $element['#url'] = $settings['url_settings']['url'];
    $element['#rel_field'] = $settings['url_settings']['rel_field'];
    $element['#class_field'] = $settings['url_settings']['class_field'];
    $element['#custom_target'] = $settings['url_settings']['custom_target'];
    $element['#target'] = $settings['url_settings']['target'];
    $element['#longdesc_field'] = $settings['longdesc_field'];
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public static function process($element, &$form_state, $form) {
    $element = parent::process($element, $form_state, $form);
    $item = $element['#value'];
    $item['fids'] = $element['fids']['#value'];
    $element['url'] = array(
      '#title' => t('Link URL'),
      '#type' => 'textfield',
      '#default_value' => isset($item['url']) ? $item['url'] : $element['#url'],
      '#description' => t('This URL will be loaded when the image is clicked'),
      '#weight' => -4,
      '#access' => (bool) $item['fids'],
    );
    $element['rel'] = array(
      '#title' => t('Link Rel'),
      '#type' => 'textfield',
      '#default_value' => isset($item['rel']) ? $item['rel'] : '',
      '#description' => t('Add rel attributes for bots, lightbox galleries, etc...'),
      '#maxlength' => \Drupal::config('linkimagefield.basic')
        ->get('image_longdesc_length'),
      '#weight' => -4,
      '#access' => (bool) $item['fids'] && $element['#rel_field'],
    );
    $element['class'] = array(
      '#title' => t('Link Class'),
      '#type' => 'textfield',
      '#default_value' => isset($item['class']) ? $item['class'] : '',
      '#description' => t('Add classes for theming, colorboxes, etc...'),
      '#maxlength' => \Drupal::config('linkimagefield.basic')
        ->get('image_longdesc_length'),
      '#weight' => -4,
      '#access' => (bool) $item['fids'] && $element['#class_field'],
    );
    $custom_target = $element['#custom_target'];
    $options = array(
      'default' => t('Use Default') . ' (' . $element['#target'] . ')',
    ) + _linkimagefield_widget_url_target_options();
    $element['target'] = array(
      '#title' => t('Link Target'),
      '#type' => $custom_target ? 'select' : 'value',
      '#options' => $custom_target ? $options : NULL,
      '#default_value' => $custom_target && isset($item['target']) ? $item['target'] : $element['#target'],
      '#description' => t('Window/Frame Target for the URL'),
      '#weight' => -4,
      '#access' => (bool) $item['fids'] && $custom_target,
    );
    $element['longdesc'] = array(
      '#title' => t('Image Longdesc'),
      '#type' => 'textfield',
      '#default_value' => isset($item['longdesc']) ? $item['longdesc'] : '',
      '#description' => t('The longdesc is used to provide a link to a long description of the image.'),
      '#maxlength' => \Drupal::config('linkimagefield.basic')
        ->get('image_longdesc_length'),
      '#weight' => -1,
      '#access' => (bool) $item['fids'] && $element['#longdesc_field'],
    );
    return $element;
  }

}

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::create public static function Creates an instance of the plugin. Overrides WidgetBase::create
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.
ImageWidget::$imageFactory protected property The image factory service.
ImageWidget::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides PluginSettingsBase::calculateDependencies
ImageWidget::defaultSettings public static function Defines the default settings for this plugin. Overrides FileWidget::defaultSettings
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::settingsForm public function Returns a form to configure settings for the widget. Overrides FileWidget::settingsForm
ImageWidget::settingsSummary public function Returns a short summary for the current widget settings. Overrides FileWidget::settingsSummary
ImageWidget::validateRequiredFields public static function Validate callback for alt and title field, if the user wants them required.
ImageWidget::__construct public function Constructs an ImageWidget object. Overrides FileWidget::__construct
LinkImageFieldWidget::formElement public function Returns the form for a single field widget. Overrides ImageWidget::formElement
LinkImageFieldWidget::process public static function Form API callback: Processes a image_image field element. Overrides ImageWidget::process
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